|
|
|
# Copyright 2015 The Meson development team
|
|
|
|
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
|
|
|
|
from mesonbuild.dependencies.base import find_external_dependency
|
|
|
|
import os
|
|
|
|
import shutil
|
|
|
|
import typing as T
|
|
|
|
|
|
|
|
from .. import mlog
|
|
|
|
from .. import build
|
|
|
|
from .. import mesonlib
|
|
|
|
from ..mesonlib import MesonException, extract_as_list, File, unholder, version_compare
|
|
|
|
from ..dependencies import Dependency
|
|
|
|
import xml.etree.ElementTree as ET
|
|
|
|
from . import ModuleReturnValue, ExtensionModule
|
|
|
|
from ..interpreterbase import noPosargs, permittedKwargs, FeatureNew, FeatureNewKwargs
|
|
|
|
from ..interpreter import extract_required_kwarg
|
|
|
|
from ..programs import NonExistingExternalProgram
|
|
|
|
|
|
|
|
if T.TYPE_CHECKING:
|
|
|
|
from ..interpreter import Interpreter
|
|
|
|
from ..dependencies.qt import QtBaseDependency
|
|
|
|
from ..environment import Environment
|
|
|
|
from ..programs import ExternalProgram
|
|
|
|
|
|
|
|
|
|
|
|
class QtBaseModule(ExtensionModule):
|
|
|
|
tools_detected = False
|
|
|
|
rcc_supports_depfiles = False
|
|
|
|
|
|
|
|
def __init__(self, interpreter: 'Interpreter', qt_version=5):
|
|
|
|
ExtensionModule.__init__(self, interpreter)
|
|
|
|
self.snippets.add('has_tools')
|
|
|
|
self.qt_version = qt_version
|
|
|
|
self.moc: 'ExternalProgram' = NonExistingExternalProgram('moc')
|
|
|
|
self.uic: 'ExternalProgram' = NonExistingExternalProgram('uic')
|
|
|
|
self.rcc: 'ExternalProgram' = NonExistingExternalProgram('rcc')
|
|
|
|
self.lrelease: 'ExternalProgram' = NonExistingExternalProgram('lrelease')
|
|
|
|
|
|
|
|
def compilers_detect(self, qt_dep: 'QtBaseDependency') -> None:
|
|
|
|
"""Detect Qt (4 or 5) moc, uic, rcc in the specified bindir or in PATH"""
|
|
|
|
# It is important that this list does not change order as the order of
|
|
|
|
# the returned ExternalPrograms will change as well
|
|
|
|
bins = ['moc', 'uic', 'rcc', 'lrelease']
|
|
|
|
found = {b: NonExistingExternalProgram(name=f'{b}-qt{qt_dep.qtver}')
|
|
|
|
for b in bins}
|
|
|
|
wanted = f'== {qt_dep.version}'
|
|
|
|
|
|
|
|
def gen_bins() -> T.Generator[T.Tuple[str, str], None, None]:
|
|
|
|
for b in bins:
|
|
|
|
if qt_dep.bindir:
|
|
|
|
yield os.path.join(qt_dep.bindir, b), b
|
|
|
|
# prefer the <tool>-qt<version> of the tool to the plain one, as we
|
|
|
|
# don't know what the unsuffixed one points to without calling it.
|
|
|
|
yield f'{b}-qt{qt_dep.qtver}', b
|
|
|
|
yield b, b
|
|
|
|
|
|
|
|
for b, name in gen_bins():
|
|
|
|
if found[name].found():
|
|
|
|
continue
|
|
|
|
|
|
|
|
if name == 'lrelease':
|
|
|
|
arg = ['-version']
|
|
|
|
elif mesonlib.version_compare(qt_dep.version, '>= 5'):
|
|
|
|
arg = ['--version']
|
|
|
|
else:
|
|
|
|
arg = ['-v']
|
|
|
|
|
|
|
|
# Ensure that the version of qt and each tool are the same
|
|
|
|
def get_version(p: 'ExternalProgram') -> str:
|
|
|
|
_, out, err = mesonlib.Popen_safe(p.get_command() + arg)
|
|
|
|
if b.startswith('lrelease') or not qt_dep.version.startswith('4'):
|
|
|
|
care = out
|
|
|
|
else:
|
|
|
|
care = err
|
|
|
|
return care.split(' ')[-1].replace(')', '').strip()
|
|
|
|
|
|
|
|
p = self.interpreter.find_program_impl(
|
|
|
|
[b], required=False,
|
|
|
|
version_func=get_version,
|
|
|
|
wanted=wanted).held_object
|
|
|
|
if p.found():
|
|
|
|
setattr(self, name, p)
|
|
|
|
|
|
|
|
def _detect_tools(self, env: 'Environment', method, required=True):
|
|
|
|
if self.tools_detected:
|
|
|
|
return
|
|
|
|
self.tools_detected = True
|
|
|
|
mlog.log(f'Detecting Qt{self.qt_version} tools')
|
|
|
|
kwargs = {'required': required, 'modules': 'Core', 'method': method}
|
|
|
|
qt = find_external_dependency(f'qt{self.qt_version}', env, kwargs)
|
|
|
|
if qt.found():
|
|
|
|
# Get all tools and then make sure that they are the right version
|
|
|
|
self.compilers_detect(qt)
|
|
|
|
if version_compare(qt.version, '>=5.14.0'):
|
|
|
|
self.rcc_supports_depfiles = True
|
|
|
|
else:
|
|
|
|
mlog.warning('rcc dependencies will not work properly until you move to Qt >= 5.14:',
|
|
|
|
mlog.bold('https://bugreports.qt.io/browse/QTBUG-45460'), fatal=False)
|
|
|
|
else:
|
|
|
|
suffix = f'-qt{self.qt_version}'
|
|
|
|
self.moc = NonExistingExternalProgram(name='moc' + suffix)
|
|
|
|
self.uic = NonExistingExternalProgram(name='uic' + suffix)
|
|
|
|
self.rcc = NonExistingExternalProgram(name='rcc' + suffix)
|
|
|
|
self.lrelease = NonExistingExternalProgram(name='lrelease' + suffix)
|
|
|
|
|
|
|
|
def qrc_nodes(self, state, rcc_file):
|
|
|
|
if type(rcc_file) is str:
|
|
|
|
abspath = os.path.join(state.environment.source_dir, state.subdir, rcc_file)
|
|
|
|
rcc_dirname = os.path.dirname(abspath)
|
|
|
|
elif type(rcc_file) is File:
|
|
|
|
abspath = rcc_file.absolute_path(state.environment.source_dir, state.environment.build_dir)
|
|
|
|
rcc_dirname = os.path.dirname(abspath)
|
|
|
|
|
|
|
|
try:
|
|
|
|
tree = ET.parse(abspath)
|
|
|
|
root = tree.getroot()
|
|
|
|
result = []
|
|
|
|
for child in root[0]:
|
|
|
|
if child.tag != 'file':
|
|
|
|
mlog.warning("malformed rcc file: ", os.path.join(state.subdir, rcc_file))
|
|
|
|
break
|
|
|
|
else:
|
|
|
|
result.append(child.text)
|
|
|
|
|
|
|
|
return rcc_dirname, result
|
|
|
|
except Exception:
|
|
|
|
raise MesonException(f'Unable to parse resource file {abspath}')
|
|
|
|
|
|
|
|
def parse_qrc_deps(self, state, rcc_file):
|
|
|
|
rcc_dirname, nodes = self.qrc_nodes(state, rcc_file)
|
|
|
|
result = []
|
|
|
|
for resource_path in nodes:
|
|
|
|
# We need to guess if the pointed resource is:
|
|
|
|
# a) in build directory -> implies a generated file
|
|
|
|
# b) in source directory
|
|
|
|
# c) somewhere else external dependency file to bundle
|
|
|
|
#
|
|
|
|
# Also from qrc documentation: relative path are always from qrc file
|
|
|
|
# So relative path must always be computed from qrc file !
|
|
|
|
if os.path.isabs(resource_path):
|
|
|
|
# a)
|
|
|
|
if resource_path.startswith(os.path.abspath(state.environment.build_dir)):
|
|
|
|
resource_relpath = os.path.relpath(resource_path, state.environment.build_dir)
|
|
|
|
result.append(File(is_built=True, subdir='', fname=resource_relpath))
|
|
|
|
# either b) or c)
|
|
|
|
else:
|
|
|
|
result.append(File(is_built=False, subdir=state.subdir, fname=resource_path))
|
|
|
|
else:
|
|
|
|
path_from_rcc = os.path.normpath(os.path.join(rcc_dirname, resource_path))
|
|
|
|
# a)
|
|
|
|
if path_from_rcc.startswith(state.environment.build_dir):
|
|
|
|
result.append(File(is_built=True, subdir=state.subdir, fname=resource_path))
|
|
|
|
# b)
|
|
|
|
else:
|
|
|
|
result.append(File(is_built=False, subdir=state.subdir, fname=path_from_rcc))
|
|
|
|
return result
|
|
|
|
|
|
|
|
@noPosargs
|
|
|
|
@permittedKwargs({'method', 'required'})
|
|
|
|
@FeatureNew('qt.has_tools', '0.54.0')
|
|
|
|
def has_tools(self, interpreter, state, args, kwargs):
|
|
|
|
method = kwargs.get('method', 'auto')
|
|
|
|
disabled, required, feature = extract_required_kwarg(kwargs, state.subproject, default=False)
|
|
|
|
if disabled:
|
|
|
|
mlog.log('qt.has_tools skipped: feature', mlog.bold(feature), 'disabled')
|
|
|
|
return False
|
|
|
|
self._detect_tools(state.environment, method, required=False)
|
|
|
|
for tool in (self.moc, self.uic, self.rcc, self.lrelease):
|
|
|
|
if not tool.found():
|
|
|
|
if required:
|
|
|
|
raise MesonException('Qt tools not found')
|
|
|
|
return False
|
|
|
|
return True
|
|
|
|
|
|
|
|
@FeatureNewKwargs('qt.preprocess', '0.49.0', ['uic_extra_arguments'])
|
|
|
|
@FeatureNewKwargs('qt.preprocess', '0.44.0', ['moc_extra_arguments'])
|
|
|
|
@FeatureNewKwargs('qt.preprocess', '0.49.0', ['rcc_extra_arguments'])
|
|
|
|
@permittedKwargs({'moc_headers', 'moc_sources', 'uic_extra_arguments', 'moc_extra_arguments', 'rcc_extra_arguments', 'include_directories', 'dependencies', 'ui_files', 'qresources', 'method'})
|
|
|
|
def preprocess(self, state, args, kwargs):
|
|
|
|
rcc_files, ui_files, moc_headers, moc_sources, uic_extra_arguments, moc_extra_arguments, rcc_extra_arguments, sources, include_directories, dependencies \
|
|
|
|
= [extract_as_list(kwargs, c, pop=True) for c in ['qresources', 'ui_files', 'moc_headers', 'moc_sources', 'uic_extra_arguments', 'moc_extra_arguments', 'rcc_extra_arguments', 'sources', 'include_directories', 'dependencies']]
|
|
|
|
sources += args[1:]
|
|
|
|
method = kwargs.get('method', 'auto')
|
|
|
|
self._detect_tools(state.environment, method)
|
|
|
|
err_msg = "{0} sources specified and couldn't find {1}, " \
|
|
|
|
"please check your qt{2} installation"
|
|
|
|
if (moc_headers or moc_sources) and not self.moc.found():
|
|
|
|
raise MesonException(err_msg.format('MOC', f'moc-qt{self.qt_version}', self.qt_version))
|
|
|
|
if rcc_files:
|
|
|
|
if not self.rcc.found():
|
|
|
|
raise MesonException(err_msg.format('RCC', f'rcc-qt{self.qt_version}', self.qt_version))
|
|
|
|
# custom output name set? -> one output file, multiple otherwise
|
|
|
|
if args:
|
|
|
|
qrc_deps = []
|
|
|
|
for i in rcc_files:
|
|
|
|
qrc_deps += self.parse_qrc_deps(state, i)
|
|
|
|
name = args[0]
|
|
|
|
rcc_kwargs = {'input': rcc_files,
|
|
|
|
'output': name + '.cpp',
|
|
|
|
'command': [self.rcc, '-name', name, '-o', '@OUTPUT@', rcc_extra_arguments, '@INPUT@'],
|
|
|
|
'depend_files': qrc_deps}
|
|
|
|
res_target = build.CustomTarget(name, state.subdir, state.subproject, rcc_kwargs)
|
|
|
|
sources.append(res_target)
|
|
|
|
else:
|
|
|
|
for rcc_file in rcc_files:
|
|
|
|
qrc_deps = self.parse_qrc_deps(state, rcc_file)
|
|
|
|
if type(rcc_file) is str:
|
|
|
|
basename = os.path.basename(rcc_file)
|
|
|
|
elif type(rcc_file) is File:
|
|
|
|
basename = os.path.basename(rcc_file.fname)
|
|
|
|
name = 'qt' + str(self.qt_version) + '-' + basename.replace('.', '_')
|
|
|
|
rcc_kwargs = {'input': rcc_file,
|
|
|
|
'output': name + '.cpp',
|
|
|
|
'command': [self.rcc, '-name', '@BASENAME@', '-o', '@OUTPUT@', rcc_extra_arguments, '@INPUT@'],
|
|
|
|
'depend_files': qrc_deps}
|
|
|
|
if self.rcc_supports_depfiles:
|
|
|
|
rcc_kwargs['depfile'] = name + '.d'
|
|
|
|
rcc_kwargs['command'] += ['--depfile', '@DEPFILE@']
|
|
|
|
res_target = build.CustomTarget(name, state.subdir, state.subproject, rcc_kwargs)
|
|
|
|
sources.append(res_target)
|
|
|
|
if ui_files:
|
|
|
|
if not self.uic.found():
|
|
|
|
raise MesonException(err_msg.format('UIC', f'uic-qt{self.qt_version}', self.qt_version))
|
|
|
|
arguments = uic_extra_arguments + ['-o', '@OUTPUT@', '@INPUT@']
|
|
|
|
ui_kwargs = {'output': 'ui_@BASENAME@.h',
|
|
|
|
'arguments': arguments}
|
|
|
|
ui_gen = build.Generator([self.uic], ui_kwargs)
|
|
|
|
ui_output = ui_gen.process_files(f'Qt{self.qt_version} ui', ui_files, state)
|
|
|
|
sources.append(ui_output)
|
|
|
|
inc = state.get_include_args(include_dirs=include_directories)
|
|
|
|
compile_args = []
|
|
|
|
for dep in unholder(dependencies):
|
|
|
|
if isinstance(dep, Dependency):
|
|
|
|
for arg in dep.get_all_compile_args():
|
|
|
|
if arg.startswith('-I') or arg.startswith('-D'):
|
|
|
|
compile_args.append(arg)
|
|
|
|
else:
|
|
|
|
raise MesonException('Argument is of an unacceptable type {!r}.\nMust be '
|
|
|
|
'either an external dependency (returned by find_library() or '
|
|
|
|
'dependency()) or an internal dependency (returned by '
|
|
|
|
'declare_dependency()).'.format(type(dep).__name__))
|
|
|
|
if moc_headers:
|
|
|
|
arguments = moc_extra_arguments + inc + compile_args + ['@INPUT@', '-o', '@OUTPUT@']
|
|
|
|
moc_kwargs = {'output': 'moc_@BASENAME@.cpp',
|
|
|
|
'arguments': arguments}
|
|
|
|
moc_gen = build.Generator([self.moc], moc_kwargs)
|
|
|
|
moc_output = moc_gen.process_files(f'Qt{self.qt_version} moc header', moc_headers, state)
|
|
|
|
sources.append(moc_output)
|
|
|
|
if moc_sources:
|
|
|
|
arguments = moc_extra_arguments + inc + compile_args + ['@INPUT@', '-o', '@OUTPUT@']
|
|
|
|
moc_kwargs = {'output': '@BASENAME@.moc',
|
|
|
|
'arguments': arguments}
|
|
|
|
moc_gen = build.Generator([self.moc], moc_kwargs)
|
|
|
|
moc_output = moc_gen.process_files(f'Qt{self.qt_version} moc source', moc_sources, state)
|
|
|
|
sources.append(moc_output)
|
|
|
|
return ModuleReturnValue(sources, sources)
|
|
|
|
|
|
|
|
@FeatureNew('qt.compile_translations', '0.44.0')
|
|
|
|
@FeatureNewKwargs('qt.compile_translations', '0.56.0', ['qresource'])
|
|
|
|
@FeatureNewKwargs('qt.compile_translations', '0.56.0', ['rcc_extra_arguments'])
|
|
|
|
@permittedKwargs({'ts_files', 'qresource', 'rcc_extra_arguments', 'install', 'install_dir', 'build_by_default', 'method'})
|
|
|
|
def compile_translations(self, state, args, kwargs):
|
|
|
|
ts_files, install_dir = [extract_as_list(kwargs, c, pop=True) for c in ['ts_files', 'install_dir']]
|
|
|
|
qresource = kwargs.get('qresource')
|
|
|
|
if qresource:
|
|
|
|
if ts_files:
|
|
|
|
raise MesonException('qt.compile_translations: Cannot specify both ts_files and qresource')
|
|
|
|
if os.path.dirname(qresource) != '':
|
|
|
|
raise MesonException('qt.compile_translations: qresource file name must not contain a subdirectory.')
|
|
|
|
qresource = File.from_built_file(state.subdir, qresource)
|
|
|
|
infile_abs = os.path.join(state.environment.source_dir, qresource.relative_name())
|
|
|
|
outfile_abs = os.path.join(state.environment.build_dir, qresource.relative_name())
|
|
|
|
os.makedirs(os.path.dirname(outfile_abs), exist_ok=True)
|
|
|
|
shutil.copy2(infile_abs, outfile_abs)
|
|
|
|
self.interpreter.add_build_def_file(infile_abs)
|
|
|
|
|
|
|
|
rcc_file, nodes = self.qrc_nodes(state, qresource)
|
|
|
|
for c in nodes:
|
|
|
|
if c.endswith('.qm'):
|
|
|
|
ts_files.append(c.rstrip('.qm')+'.ts')
|
|
|
|
else:
|
|
|
|
raise MesonException(f'qt.compile_translations: qresource can only contain qm files, found {c}')
|
|
|
|
results = self.preprocess(state, [], {'qresources': qresource, 'rcc_extra_arguments': kwargs.get('rcc_extra_arguments', [])})
|
|
|
|
self._detect_tools(state.environment, kwargs.get('method', 'auto'))
|
|
|
|
translations = []
|
|
|
|
for ts in ts_files:
|
|
|
|
if not self.lrelease.found():
|
|
|
|
raise MesonException('qt.compile_translations: ' +
|
|
|
|
self.lrelease.name + ' not found')
|
|
|
|
if qresource:
|
|
|
|
outdir = os.path.dirname(os.path.normpath(os.path.join(state.subdir, ts)))
|
|
|
|
ts = os.path.basename(ts)
|
|
|
|
else:
|
|
|
|
outdir = state.subdir
|
|
|
|
cmd = [self.lrelease, '@INPUT@', '-qm', '@OUTPUT@']
|
|
|
|
lrelease_kwargs = {'output': '@BASENAME@.qm',
|
|
|
|
'input': ts,
|
|
|
|
'install': kwargs.get('install', False),
|
|
|
|
'build_by_default': kwargs.get('build_by_default', False),
|
|
|
|
'command': cmd}
|
|
|
|
if install_dir is not None:
|
|
|
|
lrelease_kwargs['install_dir'] = install_dir
|
|
|
|
lrelease_target = build.CustomTarget(f'qt{self.qt_version}-compile-{ts}', outdir, state.subproject, lrelease_kwargs)
|
|
|
|
translations.append(lrelease_target)
|
|
|
|
if qresource:
|
|
|
|
return ModuleReturnValue(results.return_value[0], [results.new_objects, translations])
|
|
|
|
else:
|
|
|
|
return ModuleReturnValue(translations, translations)
|