conans/client/generators/__init__.py
import os
import traceback
from os.path import join
from conan.tools.env import VirtualRunEnv
from conans.client.generators.cmake_find_package import CMakeFindPackageGenerator
from conans.client.generators.cmake_find_package_multi import CMakeFindPackageMultiGenerator
from conans.client.generators.compiler_args import CompilerArgsGenerator
from conans.client.generators.pkg_config import PkgConfigGenerator
from conans.client.subsystems import deduce_subsystem, subsystem_path
from conans.errors import ConanException, conanfile_exception_formatter
from conans.util.env_reader import get_env
from conans.util.files import normalize, save, mkdir
from .b2 import B2Generator
from .boostbuild import BoostBuildGenerator
from .cmake import CMakeGenerator
from .cmake_multi import CMakeMultiGenerator
from .cmake_paths import CMakePathsGenerator
from .deploy import DeployGenerator
from .gcc import GCCGenerator
from .json_generator import JsonGenerator
from .make import MakeGenerator
from .markdown import MarkdownGenerator
from .premake import PremakeGenerator
from .qbs import QbsGenerator
from .qmake import QmakeGenerator
from .scons import SConsGenerator
from .text import TXTGenerator
from .virtualbuildenv import VirtualBuildEnvGenerator
from .virtualenv import VirtualEnvGenerator
from .virtualenv_python import VirtualEnvPythonGenerator
from .virtualrunenv import VirtualRunEnvGenerator
from .visualstudio import VisualStudioGenerator
from .visualstudio_multi import VisualStudioMultiGenerator
from .visualstudiolegacy import VisualStudioLegacyGenerator
from .xcode import XCodeGenerator
from .ycm import YouCompleteMeGenerator
from ..tools import chdir
class GeneratorManager(object):
def __init__(self):
self._generators = {"txt": TXTGenerator,
"gcc": GCCGenerator,
"compiler_args": CompilerArgsGenerator,
"cmake": CMakeGenerator,
"cmake_multi": CMakeMultiGenerator,
"cmake_paths": CMakePathsGenerator,
"cmake_find_package": CMakeFindPackageGenerator,
"cmake_find_package_multi": CMakeFindPackageMultiGenerator,
"qmake": QmakeGenerator,
"qbs": QbsGenerator,
"scons": SConsGenerator,
"visual_studio": VisualStudioGenerator,
"visual_studio_multi": VisualStudioMultiGenerator,
"visual_studio_legacy": VisualStudioLegacyGenerator,
"xcode": XCodeGenerator,
"ycm": YouCompleteMeGenerator,
"virtualenv": VirtualEnvGenerator,
"virtualenv_python": VirtualEnvPythonGenerator,
"virtualbuildenv": VirtualBuildEnvGenerator,
"virtualrunenv": VirtualRunEnvGenerator,
"boost-build": BoostBuildGenerator,
"pkg_config": PkgConfigGenerator,
"json": JsonGenerator,
"b2": B2Generator,
"premake": PremakeGenerator,
"make": MakeGenerator,
"deploy": DeployGenerator,
"markdown": MarkdownGenerator}
self._new_generators = ["CMakeToolchain", "CMakeDeps", "MSBuildToolchain",
"MesonToolchain", "MSBuildDeps", "QbsToolchain", "msbuild",
"VirtualRunEnv", "VirtualBuildEnv", "AutotoolsDeps",
"AutotoolsToolchain", "BazelDeps", "BazelToolchain", "PkgConfigDeps",
"VCVars", "IntelCC", "XcodeDeps", "PremakeDeps", "XcodeToolchain",
"MesonDeps", "NMakeToolchain", "NMakeDeps", "SConsDeps"]
def add(self, name, generator_class, custom=False):
if name not in self._generators or custom:
self._generators[name] = generator_class
def __contains__(self, name):
return name in self._generators
def __getitem__(self, key):
return self._generators[key]
def _new_generator(self, generator_name, output):
if generator_name not in self._new_generators:
return
if generator_name in self._generators: # Avoid colisions with user custom generators
msg = ("******* Your custom generator name '{}' is colliding with a new experimental "
"built-in one. It is recommended to rename it. *******".format(generator_name))
output.warn(msg)
return
if generator_name == "CMakeToolchain":
from conan.tools.cmake import CMakeToolchain
return CMakeToolchain
elif generator_name == "CMakeDeps":
from conan.tools.cmake import CMakeDeps
return CMakeDeps
elif generator_name == "AutotoolsDeps":
from conan.tools.gnu import AutotoolsDeps
return AutotoolsDeps
elif generator_name == "AutotoolsToolchain":
from conan.tools.gnu import AutotoolsToolchain
return AutotoolsToolchain
elif generator_name == "PkgConfigDeps":
from conan.tools.gnu import PkgConfigDeps
return PkgConfigDeps
elif generator_name == "MSBuildToolchain":
from conan.tools.microsoft import MSBuildToolchain
return MSBuildToolchain
elif generator_name == "MesonToolchain":
from conan.tools.meson import MesonToolchain
return MesonToolchain
elif generator_name == "MesonDeps":
from conan.tools.meson import MesonDeps
return MesonDeps
elif generator_name == "MSBuildDeps":
from conan.tools.microsoft import MSBuildDeps
return MSBuildDeps
elif generator_name == "VCVars":
from conan.tools.microsoft import VCVars
return VCVars
elif generator_name == "IntelCC":
from conan.tools.intel import IntelCC
return IntelCC
elif generator_name == "QbsToolchain" or generator_name == "QbsProfile":
from conan.tools.qbs.qbsprofile import QbsProfile
return QbsProfile
elif generator_name == "VirtualBuildEnv":
from conan.tools.env.virtualbuildenv import VirtualBuildEnv
return VirtualBuildEnv
elif generator_name == "VirtualRunEnv":
from conan.tools.env.virtualrunenv import VirtualRunEnv
return VirtualRunEnv
elif generator_name == "BazelDeps":
from conan.tools.google import BazelDeps
return BazelDeps
elif generator_name == "BazelToolchain":
from conan.tools.google import BazelToolchain
return BazelToolchain
elif generator_name == "XcodeDeps":
from conan.tools.apple import XcodeDeps
return XcodeDeps
elif generator_name == "PremakeDeps":
from conan.tools.premake import PremakeDeps
return PremakeDeps
elif generator_name == "XcodeToolchain":
from conan.tools.apple import XcodeToolchain
return XcodeToolchain
elif generator_name == "NMakeToolchain":
from conan.tools.microsoft import NMakeToolchain
return NMakeToolchain
elif generator_name == "NMakeDeps":
from conan.tools.microsoft import NMakeDeps
return NMakeDeps
elif generator_name == "SConsDeps":
from conan.tools.scons import SConsDeps
return SConsDeps
else:
raise ConanException("Internal Conan error: Generator '{}' "
"not commplete".format(generator_name))
def write_generators(self, conanfile, old_gen_folder, new_gen_folder, output):
""" produces auxiliary files, required to build a project or a package.
"""
_receive_conf(conanfile)
for generator_name in set(conanfile.generators):
generator_class = self._new_generator(generator_name, output)
if generator_class:
try:
generator = generator_class(conanfile)
output.highlight("Generator '{}' calling 'generate()'".format(generator_name))
mkdir(new_gen_folder)
with chdir(new_gen_folder):
generator.generate()
continue
except Exception as e:
output.error(traceback.format_exc())
raise ConanException("Error in generator '{}': {}".format(generator_name,
str(e)))
try:
generator_class = self._generators[generator_name]
except KeyError:
available = list(self._generators.keys()) + self._new_generators
raise ConanException("Invalid generator '%s'. Available types: %s" %
(generator_name, ", ".join(available)))
try:
generator = generator_class(conanfile)
except TypeError:
# To allow old-style generator packages to work (e.g. premake)
output.warn("Generator %s failed with new __init__(), trying old one")
generator = generator_class(conanfile.deps_cpp_info, conanfile.cpp_info)
try:
generator.output_path = old_gen_folder
content = generator.content
if generator_name != "txt":
conanfile.output.warn(f"\n"
f" ************************************************\n"
f" The '{generator_name}' generator is deprecated.\n"
f" Please update your code and remove it.\n"
f" *************************************************\n")
if isinstance(content, dict):
if generator.filename:
output.warn("Generator %s is multifile. Property 'filename' not used"
% (generator_name,))
for k, v in content.items():
if generator.normalize: # To not break existing behavior, to be removed 2.0
v = normalize(v)
output.info("Generator %s created %s" % (generator_name, k))
save(join(old_gen_folder, k), v, only_if_modified=True)
else:
content = normalize(content)
output.info("Generator %s created %s" % (generator_name, generator.filename))
save(join(old_gen_folder, generator.filename), content, only_if_modified=True)
except Exception as e:
if get_env("CONAN_VERBOSE_TRACEBACK", False):
output.error(traceback.format_exc())
output.error("Generator %s(file:%s) failed\n%s"
% (generator_name, generator.filename, str(e)))
raise ConanException(e)
def _receive_conf(conanfile):
""" collect conf_info from the immediate build_requires, aggregate it and injects/update
current conf
"""
# TODO: Open question 1: Only build_requires can define config?
# TODO: Only direct build_requires?
# TODO: Is really the best mechanism to define this info? Better than env-vars?
# Conf only for first level build_requires
for build_require in conanfile.dependencies.direct_build.values():
if build_require.conf_info:
conanfile.conf.compose_conf(build_require.conf_info)
def write_toolchain(conanfile, path, output):
if hasattr(conanfile, "toolchain"):
msg = ("\n*****************************************************************\n"
"******************************************************************\n"
"The 'toolchain' attribute or method has been deprecated and removed\n"
"Use 'generators = \"ClassName\"' or 'generate()' method instead.\n"
"********************************************************************\n"
"********************************************************************\n")
raise ConanException(msg)
if hasattr(conanfile, "generate"):
output.highlight("Calling generate()")
mkdir(path)
with chdir(path):
with conanfile_exception_formatter(str(conanfile), "generate"):
conanfile.generate()
# tools.env.virtualenv:auto_use will be always True in Conan 2.0
if conanfile.conf["tools.env.virtualenv:auto_use"]:
mkdir(path)
with chdir(path):
if conanfile.virtualbuildenv:
from conan.tools.env.virtualbuildenv import VirtualBuildEnv
env = VirtualBuildEnv(conanfile)
env.generate()
if conanfile.virtualrunenv:
env = VirtualRunEnv(conanfile)
env.generate()
output.highlight("Aggregating env generators")
_generate_aggregated_env(conanfile)
def _generate_aggregated_env(conanfile):
def deactivates(filenames):
# FIXME: Probably the order needs to be reversed
result = []
for s in filenames:
folder, f = os.path.split(s)
result.append(os.path.join(folder, "deactivate_{}".format(f)))
return result
for group, env_scripts in conanfile.env_scripts.items():
subsystem = deduce_subsystem(conanfile, group)
bats = []
shs = []
ps1s = []
for env_script in env_scripts:
path = os.path.join(conanfile.generators_folder, env_script)
# Only the .bat and .ps1 are made relative to current script
if env_script.endswith(".bat"):
path = os.path.relpath(path, conanfile.generators_folder)
bats.append("%~dp0/"+path)
elif env_script.endswith(".sh"):
shs.append(subsystem_path(subsystem, path))
elif env_script.endswith(".ps1"):
path = os.path.relpath(path, conanfile.generators_folder)
# This $PSScriptRoot uses the current script directory
ps1s.append("$PSScriptRoot/"+path)
if shs:
def sh_content(files):
return ". " + " && . ".join('"{}"'.format(s) for s in files)
filename = "conan{}.sh".format(group)
save(os.path.join(conanfile.generators_folder, filename), sh_content(shs))
save(os.path.join(conanfile.generators_folder, "deactivate_{}".format(filename)),
sh_content(deactivates(shs)))
if bats:
def bat_content(files):
return "\r\n".join(["@echo off"] + ['call "{}"'.format(b) for b in files])
filename = "conan{}.bat".format(group)
save(os.path.join(conanfile.generators_folder, filename), bat_content(bats))
save(os.path.join(conanfile.generators_folder, "deactivate_{}".format(filename)),
bat_content(deactivates(bats)))
if ps1s:
def ps1_content(files):
return "\r\n".join(['& "{}"'.format(b) for b in files])
filename = "conan{}.ps1".format(group)
save(os.path.join(conanfile.generators_folder, filename), ps1_content(ps1s))
save(os.path.join(conanfile.generators_folder, "deactivate_{}".format(filename)),
ps1_content(deactivates(ps1s)))