Add support for building with VS 2017 integrated cmake (#125)

Use the new CMake build support in VS2017 to build without having to run cmake
separately. Removes the need to download cmake separately.

By default binaries are built in:

  %LOCALAPPDATA%\CMakeBuild\DirectXShaderCompiler\build\{build-flavor}

Build settings can be changed by modifying CMakeSettings.json.

.gitignore

@@ -24,6 +24,8 @@
 *.dmp
 # Visual Studio Code directory.
 .vscode
+# Visual Studio 2017
+.vs/
 
 #==============================================================================#
 # Explicit files to ignore (only matches one).

CMakeSettings.json

@@ -0,0 +1,349 @@
+{
+    // See https://go.microsoft.com//fwlink//?linkid=834763 for more information about this file.
+    "configurations": [
+        {
+        "name": "x86-Debug",
+        "generator": "Visual Studio 15 2017",
+        "configurationType" : "Debug",
+        "buildRoot":  "${env.LOCALAPPDATA}\\CMakeBuild\\DirectXShaderCompiler\\build\\${name}",
+        "cmakeCommandArgs":  "",
+        "buildCommandArgs": "-m -v:minimal",
+        "variables": [
+          {
+            "name": "CLANG_ENABLE_ARCMT:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "CLANG_ENABLE_STATIC_ANALYZER:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "CLANG_INCLUDE_TESTS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_INCLUDE_TESTS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "HLSL_INCLUDE_TESTS:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_TARGETS_TO_BUILD:STRING",
+            "value": "None"
+          },
+          {
+            "name": "LLVM_INCLUDE_DOCS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_INCLUDE_EXAMPLES:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LIBCLANG_BUILD_STATIC:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_OPTIMIZED_TABLEGEN:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_REQUIRES_EH:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_APPEND_VC_REV:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_ENABLE_RTTI:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_ENABLE_EH:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_DEFAULT_TARGET_TRIPLE:STRING",
+            "value": "dxil-ms-dx"
+          },
+          {
+            "name": "CLANG_BUILD_EXAMPLES:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "-DLLVM_REQUIRES_RTTI:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "-DCLANG_CL:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "-DCMAKE_SYSTEM_VERSION",
+            "value": "10.0.14393.0"
+          }
+        ]
+        },
+        {
+        "name": "x86-Release",
+        "generator": "Visual Studio 15 2017",
+        "configurationType" : "Release",
+        "buildRoot":  "${env.LOCALAPPDATA}\\CMakeBuild\\DirectXShaderCompiler\\build\\${name}",
+        "cmakeCommandArgs":  "",
+        "buildCommandArgs": "-m -v:minimal",
+        "variables": [
+          {
+            "name": "CLANG_ENABLE_ARCMT:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "CLANG_ENABLE_STATIC_ANALYZER:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "CLANG_INCLUDE_TESTS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_INCLUDE_TESTS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "HLSL_INCLUDE_TESTS:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_TARGETS_TO_BUILD:STRING",
+            "value": "None"
+          },
+          {
+            "name": "LLVM_INCLUDE_DOCS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_INCLUDE_EXAMPLES:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LIBCLANG_BUILD_STATIC:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_OPTIMIZED_TABLEGEN:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_REQUIRES_EH:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_APPEND_VC_REV:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_ENABLE_RTTI:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_ENABLE_EH:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_DEFAULT_TARGET_TRIPLE:STRING",
+            "value": "dxil-ms-dx"
+          },
+          {
+            "name": "CLANG_BUILD_EXAMPLES:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "-DLLVM_REQUIRES_RTTI:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "-DCLANG_CL:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "-DCMAKE_SYSTEM_VERSION",
+            "value": "10.0.14393.0"
+          }
+        ]
+        },
+        {
+        "name": "x64-Debug",
+        "generator": "Visual Studio 15 2017 Win64",
+        "configurationType" : "Debug",
+        "buildRoot":  "${env.LOCALAPPDATA}\\CMakeBuild\\DirectXShaderCompiler\\build\\${name}",
+        "cmakeCommandArgs":  "",
+        "buildCommandArgs": "-m -v:minimal",
+        "variables": [
+          {
+            "name": "CLANG_ENABLE_ARCMT:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "CLANG_ENABLE_STATIC_ANALYZER:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "CLANG_INCLUDE_TESTS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_INCLUDE_TESTS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "HLSL_INCLUDE_TESTS:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_TARGETS_TO_BUILD:STRING",
+            "value": "None"
+          },
+          {
+            "name": "LLVM_INCLUDE_DOCS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_INCLUDE_EXAMPLES:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LIBCLANG_BUILD_STATIC:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_OPTIMIZED_TABLEGEN:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_REQUIRES_EH:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_APPEND_VC_REV:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_ENABLE_RTTI:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_ENABLE_EH:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_DEFAULT_TARGET_TRIPLE:STRING",
+            "value": "dxil-ms-dx"
+          },
+          {
+            "name": "CLANG_BUILD_EXAMPLES:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "-DLLVM_REQUIRES_RTTI:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "-DCLANG_CL:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "-DCMAKE_SYSTEM_VERSION",
+            "value": "10.0.14393.0"
+          }
+        ]
+        },
+        {
+        "name": "x64-Release",
+        "generator": "Visual Studio 15 2017 Win64",
+        "configurationType" : "Release",
+        "buildRoot":  "${env.LOCALAPPDATA}\\CMakeBuild\\DirectXShaderCompiler\\build\\${name}",
+        "cmakeCommandArgs":  "",
+        "buildCommandArgs": "-m -v:minimal",
+        "variables": [
+          {
+            "name": "CLANG_ENABLE_ARCMT:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "CLANG_ENABLE_STATIC_ANALYZER:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "CLANG_INCLUDE_TESTS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_INCLUDE_TESTS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "HLSL_INCLUDE_TESTS:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_TARGETS_TO_BUILD:STRING",
+            "value": "None"
+          },
+          {
+            "name": "LLVM_INCLUDE_DOCS:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_INCLUDE_EXAMPLES:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LIBCLANG_BUILD_STATIC:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_OPTIMIZED_TABLEGEN:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "LLVM_REQUIRES_EH:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_APPEND_VC_REV:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_ENABLE_RTTI:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_ENABLE_EH:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "LLVM_DEFAULT_TARGET_TRIPLE:STRING",
+            "value": "dxil-ms-dx"
+          },
+          {
+            "name": "CLANG_BUILD_EXAMPLES:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "-DLLVM_REQUIRES_RTTI:BOOL",
+            "value": "ON"
+          },
+          {
+            "name": "-DCLANG_CL:BOOL",
+            "value": "OFF"
+          },
+          {
+            "name": "-DCMAKE_SYSTEM_VERSION",
+            "value": "10.0.14393.0"
+          }
+        ]
+        }
+    ]
+}

README.md

@@ -27,12 +27,16 @@ The goal of the project is to allow the broader community of shader developers t
 Before you build, you will need to have some additional software installed.
 
 * [Git](http://git-scm.com/downloads).
-* [Visual Studio 2015](https://www.visualstudio.com/downloads), Update 3. This will install the Windows Development Kit. In the install options, make sure the following options are checked:
-    * Windows 10 SDK (version 14393)
-    * Common Tools for Visual C++ 2015
+* [Visual Studio](https://www.visualstudio.com/downloads)
+  * Visual Studio 2015, Update 3. This will install the Windows Development Kit. In the install options, make sure the following options are checked:
+      * Windows 10 SDK (version 14393)
+      * Common Tools for Visual C++ 2015
+  * Visual Studio 2017. Select the following workloads:
+      * Universal Windows Platform Development
+      * Desktop Development with C++
 * [Windows 10 SDK](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk). This is needed to build tests that reference the D3D12 runtime. You may get this as part of installing/updating Visual Studio.
 * [Windows Driver Kit](https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit). No need to download and install tests. This is used to build and run tests.
-* [CMake](https://cmake.org/files/v3.4/cmake-3.4.3-win32-x86.exe). Version 3.4.3 is the supported version. You need not change your PATH variable during installation.
+* [CMake](https://cmake.org/files/v3.4/cmake-3.4.3-win32-x86.exe). Version 3.4.3 and 3.7.2 are the supported versions. You need not change your PATH variable during installation.
 * [Python](https://www.python.org/downloads/). Version 2.7.x is required, 3.x might work but it's not officially supported. You need not change your PATH variable during installation.
 
 To setup the build environment run the `utils\hct\hctstart.cmd` script passing the path to the source and build directories from a regular command prompt window. For example:
@@ -55,6 +59,24 @@ You can also clean, build and run tests with this command.
 
 To see a list of additional commands available, run `hcthelp`
 
+### Building with Visual Studio 2017
+
+You can build with vs2017 either on the command line or using the new integrated [CMake support](https://blogs.msdn.microsoft.com/vcblog/2016/11/16/cmake-support-in-visual-studio-the-visual-studio-2017-rc-update/).
+
+To build from the command line follow the normal build steps, but pass `-vs2017` as a parameter
+to `hctbuild`.
+
+To build using the integrated cmake support, simply start Visual Studio
+and open the folder where you have the source. From the CMake menu 
+select "Build CMakeLists.txt"
+
+By default the binaries will be built in %LOCALAPPDATA%\CMakeBuild\DirectXShaderCompiler\build\{build-flavor}.
+The build location can be changed by editing the `CMakeSettings.json` file.
+
+You can then use the build directory in the `hctstart` script to test the build. For example,
+
+    hctstart C:\source\DirectXShaderCompiler %LOCALAPPDATA%\CMakeBuild\DirectXShaderCompiler\build\x64-Debug
+
 ## Running Tests
 
 To run tests, open the HLSL Console and run this command after a successful build.