Feature: add support for setting CMAKE_GENERATOR_INSTANCE

conan/tools/cmake/toolchain/blocks.py

@@ -795,6 +795,9 @@ class GenericSystemBlock(Block):
  message(STATUS "Conan toolchain: CMAKE_GENERATOR_TOOLSET={{ toolset }}")
  set(CMAKE_GENERATOR_TOOLSET "{{ toolset }}" CACHE STRING "" FORCE)
  {% endif %}
+ {% if generator_instance %}
+ set(CMAKE_GENERATOR_INSTANCE "{{ generator_instance }}")
+ {% endif %}
  """)
 
  @staticmethod
@@ -955,14 +958,17 @@ def context(self):
  result = self._get_winsdk_version(system_version, generator_platform)
  system_version, winsdk_version, gen_platform_sdk_version = result
 
+ generator_instance = self._conanfile.conf.get("tools.cmake.cmaketoolchain:generator_instance")
+
  return {"toolset": toolset,
  "generator_platform": generator_platform,
  "cmake_system_name": system_name,
  "cmake_system_version": system_version,
  "cmake_system_processor": system_processor,
  "cmake_sysroot": cmake_sysroot,
  "winsdk_version": winsdk_version,
- "gen_platform_sdk_version": gen_platform_sdk_version}
+ "gen_platform_sdk_version": gen_platform_sdk_version,
+ "generator_instance": generator_instance}
 
 
 class OutputDirsBlock(Block):

conans/model/conf.py

@@ -64,6 +64,7 @@
  "tools.build:verbosity": "Verbosity of build systems if set. Possible values are 'quiet' and 'verbose'",
  "tools.compilation:verbosity": "Verbosity of compilation tools if set. Possible values are 'quiet' and 'verbose'",
  "tools.cmake.cmaketoolchain:generator": "User defined CMake generator to use instead of default",
+ "tools.cmake.cmaketoolchain:generator_instance": "Define CMAKE_GENERATOR_INSTANCE in CMakeToolchain",
  "tools.cmake.cmaketoolchain:find_package_prefer_config": "Argument for the CMAKE_FIND_PACKAGE_PREFER_CONFIG",
  "tools.cmake.cmaketoolchain:toolchain_file": "Use other existing file rather than conan_toolchain.cmake one",
  "tools.cmake.cmaketoolchain:user_toolchain": "Inject existing user toolchains at the beginning of conan_toolchain.cmake",

conans/test/integration/toolchains/cmake/test_cmaketoolchain.py

@@ -1414,3 +1414,32 @@ def build(self):
  })
  client.run("export tool")
  client.run("create consumer -pr:h host -pr:b build --build=missing")
+
+
+def test_toolchain_generator_instance():
+ windows_profile = textwrap.dedent("""
+ [settings]
+ os=Windows
+ arch=x86_64
+ [conf]
+ tools.cmake.cmaketoolchain:generator_instance=C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/
+ """)
+
+ client = TestClient(path_with_spaces=False)
+ client.save({"conanfile.txt": "[generators]\nCMakeToolchain",
+ "windows": windows_profile})
+
+ # Test passing path from profile
+ client.run("install . --profile:build=windows --profile:host=windows")
+ toolchain = client.load("conan_toolchain.cmake")
+ assert 'set(CMAKE_GENERATOR_INSTANCE "C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/")' in toolchain
+
+ # Test input from command line passing path between doble quotes
+ client.run('install . --profile:build=windows --profile:host=windows -c tools.cmake.cmaketoolchain:generator_instance="C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/"')
+ toolchain = client.load("conan_toolchain.cmake")
+ assert 'set(CMAKE_GENERATOR_INSTANCE "C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/")' in toolchain
+
+ # Test input from command line passing path between simple quotes
+ client.run('install . --profile:build=windows --profile:host=windows -c tools.cmake.cmaketoolchain:generator_instance=\'C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/\'')
+ toolchain = client.load("conan_toolchain.cmake")
+ assert 'set(CMAKE_GENERATOR_INSTANCE "C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/")' in toolchain