Conan: Move Qt option parsers to qt-conan-common
Move the QtConfigureOption and QtOptionParser to qt-conan-common where existing shared functionality can be further re-used by these parsers. Pick-to: 6.3 Task-number: QTIFW-2585 Change-Id: Ief56762f3a27bb0d6d474e8d1668234856afd732 Reviewed-by: Toni Saario <toni.saario@qt.io>
This commit is contained in:
Iikka Eklund
parent
e4cda635b1
commit
b0e613d10e
302
conanfile.py
302
conanfile.py
@ -26,309 +26,20 @@
|
|||||||
##
|
##
|
||||||
#############################################################################
|
#############################################################################
|
||||||
|
|
||||||
from conans import ConanFile, tools, Options
|
from conans import ConanFile, tools
|
||||||
from conans.errors import ConanInvalidConfiguration
|
from conans.errors import ConanInvalidConfiguration
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
import json
|
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
|
||||||
from functools import lru_cache
|
from functools import lru_cache
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Dict, List, Any, Optional
|
from typing import Dict
|
||||||
|
|
||||||
|
|
||||||
class QtConanError(Exception):
|
class QtConanError(Exception):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
class QtConfigureOption(object):
|
|
||||||
def __init__(self, name: str, type: str, values: List[Any], default: Any):
|
|
||||||
self.name = name
|
|
||||||
self.type = type
|
|
||||||
self.conan_option_name = self.convert_to_conan_option_name(name)
|
|
||||||
|
|
||||||
if type == "enum" and set(values) == {"yes", "no"}:
|
|
||||||
self._binary_option = True # matches to Conan option "yes"|"no"
|
|
||||||
values = []
|
|
||||||
self._prefix = "-"
|
|
||||||
self._value_delim = ""
|
|
||||||
elif "string" in type.lower() or type in ["enum", "cxxstd", "coverage", "sanitize"]:
|
|
||||||
# these options have a value, e.g.
|
|
||||||
# --zlib=qt (enum type)
|
|
||||||
# --c++std=c++17 (cxxstd type)
|
|
||||||
# --prefix=/foo
|
|
||||||
self._binary_option = False
|
|
||||||
self._prefix = "--"
|
|
||||||
self._value_delim = "="
|
|
||||||
# exception to the rule
|
|
||||||
if name == "qt-host-path":
|
|
||||||
self._prefix = "-"
|
|
||||||
self._value_delim = " "
|
|
||||||
else:
|
|
||||||
# e.g. -debug (void type)
|
|
||||||
self._binary_option = True
|
|
||||||
self._prefix = "-"
|
|
||||||
self._value_delim = ""
|
|
||||||
|
|
||||||
if not self._binary_option and not values:
|
|
||||||
self.possible_values = ["ANY"]
|
|
||||||
elif type == "addString":
|
|
||||||
# -make=libs -make=examples <-> -o make="libs;examples" i.e. the possible values
|
|
||||||
# can be randomly selected values in semicolon separated list -> "ANY"
|
|
||||||
self.possible_values = ["ANY"]
|
|
||||||
else:
|
|
||||||
self.possible_values = values
|
|
||||||
|
|
||||||
if self._binary_option and self.possible_values:
|
|
||||||
raise QtConanError(
|
|
||||||
"A binary option: '{0}' can not contain values: {1}".format(
|
|
||||||
name, self.possible_values
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
self.default = default
|
|
||||||
|
|
||||||
@property
|
|
||||||
def binary_option(self) -> bool:
|
|
||||||
return self._binary_option
|
|
||||||
|
|
||||||
@property
|
|
||||||
def incremental_option(self) -> bool:
|
|
||||||
return self.type == "addString"
|
|
||||||
|
|
||||||
@property
|
|
||||||
def prefix(self) -> str:
|
|
||||||
return self._prefix
|
|
||||||
|
|
||||||
@property
|
|
||||||
def value_delim(self) -> str:
|
|
||||||
return self._value_delim
|
|
||||||
|
|
||||||
def convert_to_conan_option_name(self, qt_configure_option: str) -> str:
|
|
||||||
# e.g. '-c++std' -> '-cxxstd' or '-cmake-generator' -> 'cmake_generator'
|
|
||||||
return qt_configure_option.lstrip("-").replace("-", "_").replace("+", "x")
|
|
||||||
|
|
||||||
def get_conan_option_values(self) -> Any:
|
|
||||||
# The 'None' is added as a possible value. For Conan this means it is not mandatory to pass
|
|
||||||
# this option for the build.
|
|
||||||
if self._binary_option:
|
|
||||||
return [True, False, None]
|
|
||||||
if self.possible_values == ["ANY"]:
|
|
||||||
# For 'ANY' value it can not be a List type for Conan
|
|
||||||
return "ANY"
|
|
||||||
return self.possible_values + [None] # type: ignore
|
|
||||||
|
|
||||||
def get_default_conan_option_value(self) -> Any:
|
|
||||||
return self.default
|
|
||||||
|
|
||||||
|
|
||||||
class QtOptionParser:
|
|
||||||
def __init__(self) -> None:
|
|
||||||
self.options: List[QtConfigureOption] = []
|
|
||||||
self.load_configure_options()
|
|
||||||
self.extra_options: Dict[str, Any] = {"cmake_args_qtbase": "ANY"}
|
|
||||||
self.extra_options_default_values = {"cmake_args_qtbase": None}
|
|
||||||
|
|
||||||
def load_configure_options(self) -> None:
|
|
||||||
"""Read the configure options and features dynamically via configure(.bat).
|
|
||||||
There are two contexts where the ConanFile is initialized:
|
|
||||||
- 'conan export' i.e. when the conan package is being created from sources (.git)
|
|
||||||
- inside conan's cache when invoking: 'conan install, conan info, conan inspect, ..'
|
|
||||||
"""
|
|
||||||
print("QtOptionParser: load configure options ..")
|
|
||||||
recipe_folder = Path(__file__).parent.resolve()
|
|
||||||
configure_options = recipe_folder / "configure_options.json"
|
|
||||||
configure_features = recipe_folder / "configure_features.txt"
|
|
||||||
if not configure_options.exists() or not configure_features.exists():
|
|
||||||
# This is when the 'conan export' is called
|
|
||||||
script = Path("configure.bat") if tools.os_info.is_windows else Path("configure")
|
|
||||||
root_path = recipe_folder
|
|
||||||
|
|
||||||
configure = root_path.joinpath(script).resolve()
|
|
||||||
if not configure.exists():
|
|
||||||
root_path = root_path.joinpath("..").joinpath("export_source").resolve()
|
|
||||||
if root_path.exists():
|
|
||||||
configure = root_path.joinpath(script).resolve(strict=True)
|
|
||||||
else:
|
|
||||||
raise QtConanError(
|
|
||||||
"Unable to locate 'configure(.bat)' "
|
|
||||||
"from current context: {0}".format(recipe_folder)
|
|
||||||
)
|
|
||||||
|
|
||||||
self.write_configure_options(configure, output_file=configure_options)
|
|
||||||
self.write_configure_features(configure, output_file=configure_features)
|
|
||||||
|
|
||||||
opt = self.read_configure_options(configure_options)
|
|
||||||
self.set_configure_options(opt["options"])
|
|
||||||
|
|
||||||
features = self.read_configure_features(configure_features)
|
|
||||||
self.set_features(feature_name_prefix="feature-", features=features)
|
|
||||||
|
|
||||||
def write_configure_options(self, configure: Path, output_file: Path) -> None:
|
|
||||||
print("QtOptionParser: writing Qt configure options to: {0}".format(output_file))
|
|
||||||
cmd = [str(configure), "-write-options-for-conan", str(output_file)]
|
|
||||||
subprocess.run(cmd, check=True, timeout=60 * 2)
|
|
||||||
|
|
||||||
def read_configure_options(self, input_file: Path) -> Dict[str, Any]:
|
|
||||||
print("QtOptionParser: reading Qt configure options from: {0}".format(input_file))
|
|
||||||
with open(str(input_file)) as f:
|
|
||||||
return json.load(f)
|
|
||||||
|
|
||||||
def write_configure_features(self, configure: Path, output_file: Path) -> None:
|
|
||||||
print("QtOptionParser: writing Qt configure features to: {0}".format(output_file))
|
|
||||||
cmd = [str(configure), "-list-features"]
|
|
||||||
with open(output_file, "w") as f:
|
|
||||||
subprocess.run(
|
|
||||||
cmd,
|
|
||||||
encoding="utf-8",
|
|
||||||
check=True,
|
|
||||||
timeout=60 * 2,
|
|
||||||
stderr=subprocess.STDOUT,
|
|
||||||
stdout=f,
|
|
||||||
)
|
|
||||||
|
|
||||||
def read_configure_features(self, input_file: Path) -> List[str]:
|
|
||||||
print("QtOptionParser: reading Qt configure features from: {0}".format(input_file))
|
|
||||||
with open(str(input_file)) as f:
|
|
||||||
return f.readlines()
|
|
||||||
|
|
||||||
def set_configure_options(self, configure_options: Dict[str, Any]) -> None:
|
|
||||||
for option_name, field in configure_options.items():
|
|
||||||
option_type = field.get("type")
|
|
||||||
values: List[str] = field.get("values", [])
|
|
||||||
# For the moment all Options will get 'None' as the default value
|
|
||||||
default = None
|
|
||||||
|
|
||||||
if not option_type:
|
|
||||||
raise QtConanError(
|
|
||||||
"Qt 'configure(.bat) -write-options-for-conan' produced output "
|
|
||||||
"that is missing 'type'. Unable to set options dynamically. "
|
|
||||||
"Item: {0}".format(option_name)
|
|
||||||
)
|
|
||||||
if not isinstance(values, list):
|
|
||||||
raise QtConanError("The 'values' field is not a list: {0}".format(option_name))
|
|
||||||
if option_type == "enum" and not values:
|
|
||||||
raise QtConanError("The enum values are missing for: {0}".format(option_name))
|
|
||||||
|
|
||||||
opt = QtConfigureOption(
|
|
||||||
name=option_name, type=option_type, values=values, default=default
|
|
||||||
)
|
|
||||||
self.options.append(opt)
|
|
||||||
|
|
||||||
def set_features(self, feature_name_prefix: str, features: List[str]) -> None:
|
|
||||||
for line in features:
|
|
||||||
feature_name = self.parse_feature(line)
|
|
||||||
if feature_name:
|
|
||||||
opt = QtConfigureOption(
|
|
||||||
name=feature_name_prefix + feature_name, type="void", values=[], default=None
|
|
||||||
)
|
|
||||||
self.options.append(opt)
|
|
||||||
|
|
||||||
def parse_feature(self, feature_line: str) -> Optional[str]:
|
|
||||||
parts = feature_line.split()
|
|
||||||
# e.g. 'itemmodel ................ ItemViews: Provides the item model for item views'
|
|
||||||
if not len(parts) >= 3:
|
|
||||||
return None
|
|
||||||
if not parts[1].startswith("."):
|
|
||||||
return None
|
|
||||||
return parts[0]
|
|
||||||
|
|
||||||
def get_qt_conan_options(self) -> Dict[str, Any]:
|
|
||||||
# obtain all the possible configure(.bat) options and map those to
|
|
||||||
# Conan options for the recipe
|
|
||||||
opt: Dict = {}
|
|
||||||
for qt_option in self.options:
|
|
||||||
opt[qt_option.conan_option_name] = qt_option.get_conan_option_values()
|
|
||||||
opt.update(self.extra_options)
|
|
||||||
return opt
|
|
||||||
|
|
||||||
def get_default_qt_conan_options(self) -> Dict[str, Any]:
|
|
||||||
# set the default option values for each option in case the user or CI does not pass them
|
|
||||||
opt: Dict = {}
|
|
||||||
for qt_option in self.options:
|
|
||||||
opt[qt_option.conan_option_name] = qt_option.get_default_conan_option_value()
|
|
||||||
opt.update(self.extra_options_default_values)
|
|
||||||
return opt
|
|
||||||
|
|
||||||
def is_used_option(self, conan_options: Options, option_name: str) -> bool:
|
|
||||||
# conan install ... -o release=False -> configure(.bat)
|
|
||||||
# conan install ... -> configure(.bat)
|
|
||||||
# conan install ... -o release=True -> configure(.bat) -release
|
|
||||||
return bool(conan_options.get_safe(option_name))
|
|
||||||
|
|
||||||
def convert_conan_option_to_qt_option(
|
|
||||||
self, conan_options: Options, name: str, value: Any
|
|
||||||
) -> str:
|
|
||||||
ret: str = ""
|
|
||||||
|
|
||||||
def _find_qt_option(conan_option_name: str) -> QtConfigureOption:
|
|
||||||
for qt_opt in self.options:
|
|
||||||
if conan_option_name == qt_opt.conan_option_name:
|
|
||||||
return qt_opt
|
|
||||||
else:
|
|
||||||
raise QtConanError(
|
|
||||||
"Could not find a matching Qt configure option for: {0}".format(
|
|
||||||
conan_option_name
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
def _is_excluded_from_configure() -> bool:
|
|
||||||
# extra options are not Qt configure(.bat) options but those exist as
|
|
||||||
# conan recipe options which are treated outside Qt's configure(.bat)
|
|
||||||
if name in self.extra_options.keys():
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
||||||
if self.is_used_option(conan_options, name) and not _is_excluded_from_configure():
|
|
||||||
qt_option = _find_qt_option(name)
|
|
||||||
if qt_option.incremental_option:
|
|
||||||
# e.g. -make=libs -make=examples <-> -o make=libs;examples;foo;bar
|
|
||||||
_opt = qt_option.prefix + qt_option.name + qt_option.value_delim
|
|
||||||
ret = " ".join(_opt + item.strip() for item in value.split(";") if item.strip())
|
|
||||||
else:
|
|
||||||
ret = qt_option.prefix + qt_option.name
|
|
||||||
if not qt_option.binary_option:
|
|
||||||
ret += qt_option.value_delim + value
|
|
||||||
|
|
||||||
return ret
|
|
||||||
|
|
||||||
def convert_conan_options_to_qt_options(self, conan_options: Options) -> List[str]:
|
|
||||||
qt_options: List[str] = []
|
|
||||||
|
|
||||||
def _option_enabled(opt: str) -> bool:
|
|
||||||
return bool(conan_options.get_safe(opt))
|
|
||||||
|
|
||||||
def _option_disabled(opt: str) -> bool:
|
|
||||||
return not bool(conan_options.get_safe(opt))
|
|
||||||
|
|
||||||
def _filter_overlapping_options() -> None:
|
|
||||||
if _option_enabled("shared") or _option_disabled("static"):
|
|
||||||
delattr(conan_options, "static") # should result only into "-shared"
|
|
||||||
if _option_enabled("static") or _option_disabled("shared"):
|
|
||||||
delattr(conan_options, "shared") # should result only into "-static"
|
|
||||||
|
|
||||||
_filter_overlapping_options()
|
|
||||||
|
|
||||||
for option_name, option_value in conan_options.items():
|
|
||||||
qt_option = self.convert_conan_option_to_qt_option(
|
|
||||||
conan_options=conan_options, name=option_name, value=option_value
|
|
||||||
)
|
|
||||||
if not qt_option:
|
|
||||||
continue
|
|
||||||
qt_options.append(qt_option)
|
|
||||||
return qt_options
|
|
||||||
|
|
||||||
def get_cmake_args_for_configure(self, conan_options: Options) -> List[Optional[str]]:
|
|
||||||
ret: List[Optional[str]] = []
|
|
||||||
for option_name, option_value in conan_options.items():
|
|
||||||
if option_name == "cmake_args_qtbase" and self.is_used_option(
|
|
||||||
conan_options, option_name
|
|
||||||
):
|
|
||||||
ret = [ret for ret in option_value.strip(r" '\"").split()]
|
|
||||||
return ret
|
|
||||||
|
|
||||||
|
|
||||||
def add_cmake_prefix_path(conan_file: ConanFile, dep: str) -> None:
|
def add_cmake_prefix_path(conan_file: ConanFile, dep: str) -> None:
|
||||||
if dep not in conan_file.deps_cpp_info.deps:
|
if dep not in conan_file.deps_cpp_info.deps:
|
||||||
raise QtConanError("Unable to find dependency: {0}".format(dep))
|
raise QtConanError("Unable to find dependency: {0}".format(dep))
|
||||||
@ -386,9 +97,9 @@ class QtBase(ConanFile):
|
|||||||
description = "Qt6 core framework libraries and tools."
|
description = "Qt6 core framework libraries and tools."
|
||||||
topics = ("qt", "qt6")
|
topics = ("qt", "qt6")
|
||||||
settings = "os", "compiler", "arch", "build_type"
|
settings = "os", "compiler", "arch", "build_type"
|
||||||
_qt_option_parser = QtOptionParser()
|
_qt_option_parser = None
|
||||||
options = _qt_option_parser.get_qt_conan_options()
|
options = None
|
||||||
default_options = _qt_option_parser.get_default_qt_conan_options()
|
default_options = None
|
||||||
exports_sources = "*", "!conan*.*"
|
exports_sources = "*", "!conan*.*"
|
||||||
# use commit ID as the RREV (recipe revision)
|
# use commit ID as the RREV (recipe revision)
|
||||||
revision_mode = "scm"
|
revision_mode = "scm"
|
||||||
@ -398,6 +109,9 @@ class QtBase(ConanFile):
|
|||||||
|
|
||||||
def init(self):
|
def init(self):
|
||||||
self._shared = self.python_requires["qt-conan-common"].module
|
self._shared = self.python_requires["qt-conan-common"].module
|
||||||
|
self._qt_option_parser = self._shared.QtOptionParser(Path(__file__).parent.resolve())
|
||||||
|
self.options = self._qt_option_parser.get_qt_conan_options()
|
||||||
|
self.default_options = self._qt_option_parser.get_default_qt_conan_options()
|
||||||
|
|
||||||
def set_version(self):
|
def set_version(self):
|
||||||
# Executed during "conan export" i.e. in source tree
|
# Executed during "conan export" i.e. in source tree
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user