Auto-install LLVM Visual Studio visualizers for VS2015 and up

[mspertus]

Summary

This change uses the Project Support for Natvis added in VS2015 to eliminate the need to manually install natvis files. D18498 is the correspondig diff for clang. I want to acknowledge ariccio for extensive advice on this change.

[mspertus]

Correctly handle non-Visual Studio case (e.g., Linux)

[aaron.ballman]

This is fantastic! Just a few nits, but nothing substantial.

CMakeLists.txt

739

I think the convention is to have a space between the if and the (.

740–741

Should remove the space after the open paren.

781

Spurious newline?

utils/llvm.natvis

8

Missing a terminating period.

[mspertus]

Accepting Aaron's suggestions

[aaron.ballman]

LGTM, thank you!

[mspertus]

Missed one (the missing period in llvm.natvis).

[mspertus]

Since this is now creating a project, we should do some housekeeping to move the files to different directories so that the build tree has an LLVMVisualizers project directory.

[mspertus]

Add missing newline

[ariccio]

utils/llvm.natvis is a duplicate of utils/LLVMVisualizers/llvm.natvis?

Otherwise, assuming everything builds correctly, LGTM.

Once again, thanks for doing this!

[mspertus]

In D18497#384351, @ariccio wrote:

utils/llvm.natvis is a duplicate of utils/LLVMVisualizers/llvm.natvis?

The file was moved to a more appropriate directory (Otherwise, the project files were stepping on each other).
svn mv utils/llvm.natvis utils/LLVMVisualizers/llvm.natvis

Otherwise, assuming everything builds correctly, LGTM.

There are a lot scenarios. What do all of these files in the build tree like cmake_install.cmake, install.vcxproj, Package.vcxproj? How do I test them?

Once again, thanks for doing this!

You're welcome. Thanks for all your help. I am in India right now with a limited environment. I will likely due some more testing when I get home and check in at the end of the week.

[mspertus]

Adding missing period in comment!

[ariccio]

In D18497#384362, @mspertus wrote:

In D18497#384351, @ariccio wrote:

Otherwise, assuming everything builds correctly, LGTM.

There are a lot scenarios. What do all of these files in the build tree like cmake_install.cmake, install.vcxproj, Package.vcxproj? How do I test them?

Do you have a clean copy of the tree? Maybe do something like [[ http://stackoverflow.com/questions/9680420/looking-for-a-cmake-clean-command-to-clear-up-cmake-output | the equivalent of make clean ]]? Then try to regenerate everything?

Once again, thanks for doing this!

You're welcome. Thanks for all your help. I am in India right now with a limited environment. I will likely due some more testing when I get home and check in at the end of the week.

Well that's certainly more exotic than me! I'm impressed. I assume you have a laptop, and you're not doing this on your smartphone.

[mspertus]

Committed as revisions 264601 and 264602

CMakeLists.txt

 endif()
 option(LLVM_BUILD_LLVM_DYLIB "Build libllvm dynamic library" ${LLVM_BUILD_LLVM_DYLIB_default})
 
 option(LLVM_OPTIMIZED_TABLEGEN "Force TableGen to be built with optimization" OFF)
 if(CMAKE_CROSSCOMPILING OR (LLVM_OPTIMIZED_TABLEGEN AND LLVM_ENABLE_ASSERTIONS))
   set(LLVM_USE_HOST_TOOLS ON)
 endif()
 
+if (MSVC_IDE AND NOT (MSVC_VERSION LESS 1900))
+  option(LLVM_ADD_NATIVE_VISUALIZERS_TO_SOLUTION "Configure project to use Visual Studio native visualizers" TRUE)
+else()
+  set(LLVM_ADD_NATIVE_VISUALIZERS_TO_SOLUTION FALSE CACHE INTERNAL "For Visual Studio 2013, manually copy natvis files to Documents\\Visual Studio 2013\\Visualizers" FORCE)
+endif()
+
 # All options referred to from HandleLLVMOptions have to be specified
 # BEFORE this include, otherwise options will not be correctly set on
 # first cmake run
 include(config-ix)
 
 string(REPLACE "Native" ${LLVM_NATIVE_ARCH}
   LLVM_TARGETS_TO_BUILD "${LLVM_TARGETS_TO_BUILD}")
 list(REMOVE_DUPLICATES LLVM_TARGETS_TO_BUILD)

 endif()
 
 if (LLVM_INCLUDE_DOCS)
   add_subdirectory(docs)
 endif()
 
 add_subdirectory(cmake/modules)
 
+# Do this by hand instead of using add_llvm_utilities(), which
+# tries to create a corresponding executable, which we don't want
+if (LLVM_ADD_NATIVE_VISUALIZERS_TO_SOLUTION)
+  set(LLVM_VISUALIZERS utils/llvm.natvis)
+  add_custom_target(LLVMVisualizers SOURCES ${LLVM_VISUALIZERS})
+  set_target_properties(LLVMVisualizers PROPERTIES FOLDER "Utils")
+endif()
+
 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
   install(DIRECTORY include/llvm include/llvm-c
     DESTINATION include
     COMPONENT llvm-headers
     FILES_MATCHING
     PATTERN "*.def"
     PATTERN "*.h"
     PATTERN "*.td"
if (NOT CMAKE_CONFIGURATION_TYPES)
     add_custom_target(installhdrs
                       DEPENDS ${name}
                       COMMAND "${CMAKE_COMMAND}"
                               -DCMAKE_INSTALL_COMPONENT=llvm-headers
                               -P "${CMAKE_BINARY_DIR}/cmake_install.cmake")
   endif()
 endif()
 
 # This must be at the end of the LLVM root CMakeLists file because it must run
 # after all targets are created.
 if(LLVM_DISTRIBUTION_COMPONENTS)
   if(CMAKE_CONFIGURATION_TYPES)
     message(FATAL_ERROR "LLVM_DISTRIBUTION_COMPONENTS cannot be specified with multi-configuration generators (i.e. Xcode or Visual Studio)")
   endif()
 
   add_custom_target(distribution)
   add_custom_target(install-distribution)

utils/llvm.natvis

 <?xml version="1.0" encoding="utf-8"?>
 <!--
-Visual Studio 2012 Native Debugging Visualizers for LLVM
+Visual Studio Native Debugging Visualizers for LLVM
 
-Put this file into "%USERPROFILE%\Documents\Visual Studio 2012\Visualizers"
-or create a symbolic link so it updates automatically.
+For Visual Studio 2013 only, put this file into 
+"%USERPROFILE%\Documents\Visual Studio 2013\Visualizers" or create a symbolic link so it updates automatically.
+
+For later versions of Visual Studio, no setup is required
 -->
 <AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
 
   <Type Name="llvm::SmallVectorImpl&lt;*&gt;">
     <DisplayString Condition="(($T1*)EndX - ($T1*)BeginX) == 0">empty</DisplayString>
     <DisplayString Condition="(($T1*)EndX - ($T1*)BeginX) != 0">{{ size={($T1*)EndX - ($T1*)BeginX} }}</DisplayString>
     <Expand>
       <Item Name="[size]">($T1*)EndX - ($T1*)BeginX</Item>