#!/usr/bin/env python3 # Copyright (C) 2020 The Qt Company Ltd. # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 # import the print function which is used in python 3.x from __future__ import print_function import argparse import collections import glob import os import shlex import common def get_arguments(): parser = argparse.ArgumentParser(description='Build Qt Creator for packaging') parser.add_argument('--name', help='Name to use for build results', required=True) parser.add_argument('--src', help='Path to sources', required=True) parser.add_argument('--build', help='Path that should be used for building', required=True) parser.add_argument('--qt-path', help='Path to Qt', required=True) parser.add_argument('--qtc-path', help='Path to Qt Creator installation including development package', required=True) parser.add_argument('--output-path', help='Output path for resulting 7zip files') parser.add_argument('--add-path', help='Prepends a CMAKE_PREFIX_PATH to the build', action='append', dest='prefix_paths', default=[]) parser.add_argument('--add-module-path', help='Prepends a CMAKE_MODULE_PATH to the build', action='append', dest='module_paths', default=[]) parser.add_argument('--add-make-arg', help='Passes the argument to the make tool.', action='append', dest='make_args', default=[]) parser.add_argument('--add-config', help=('Adds the argument to the CMake configuration call. ' 'Use "--add-config=-DSOMEVAR=SOMEVALUE" if the argument begins with a dash.'), action='append', dest='config_args', default=[]) parser.add_argument('--with-docs', help='Build and install documentation.', action='store_true', default=False) parser.add_argument('--add-sanitize-flags', help="Sets flags for sanitizer compilation flags used in Debug builds", action='append', dest='sanitize_flags', default=[] ) parser.add_argument('--deploy', help='Installs the "Dependencies" component of the plugin.', action='store_true', default=False) parser.add_argument('--build-type', help='Build type to pass to CMake (defaults to RelWithDebInfo)', default='RelWithDebInfo') # zipping parser.add_argument('--zip-threads', help='Sets number of threads to use for 7z. Use "+" for turning threads on ' 'without a specific number of threads. This is directly passed to the "-mmt" option of 7z.', default='2') # signing parser.add_argument('--keychain-unlock-script', help='Path to script for unlocking the keychain used for signing (macOS)') parser.add_argument('--sign-command', help='Command to use for signing (Windows). The installation directory to sign is added at the end. Is run in the CWD.') args = parser.parse_args() args.with_debug_info = args.build_type == 'RelWithDebInfo' return args def qtcreator_prefix_path(qt_creator_path): # on macOS the prefix path must be inside the app bundle, but we want to allow # simpler values for --qtc-path, so search in some variants of that candidates = [qt_creator_path, os.path.join(qt_creator_path, 'Contents', 'Resources')] candidates += [os.path.join(path, 'Contents', 'Resources') for path in glob.glob(os.path.join(qt_creator_path, '*.app'))] for path in candidates: if os.path.exists(os.path.join(path, 'lib', 'cmake')): return [path] return [qt_creator_path] def build(args, paths): if not os.path.exists(paths.build): os.makedirs(paths.build) if not os.path.exists(paths.result): os.makedirs(paths.result) prefix_paths = [os.path.abspath(fp) for fp in args.prefix_paths] + [paths.qt] prefix_paths += qtcreator_prefix_path(paths.qt_creator) prefix_paths = [common.to_posix_path(fp) for fp in prefix_paths] separate_debug_info_option = 'ON' if args.with_debug_info else 'OFF' cmake_args = ['cmake', '-DCMAKE_PREFIX_PATH=' + ';'.join(prefix_paths), '-DCMAKE_BUILD_TYPE=' + args.build_type, '-DQTC_SEPARATE_DEBUG_INFO=' + separate_debug_info_option, '-DCMAKE_INSTALL_PREFIX=' + common.to_posix_path(paths.install), '-DQT_GENERATE_SBOM=ON', '-G', 'Ninja'] if args.module_paths: module_paths = [common.to_posix_path(os.path.abspath(fp)) for fp in args.module_paths] cmake_args += ['-DCMAKE_MODULE_PATH=' + ';'.join(module_paths)] # force MSVC on Windows, because it looks for GCC in the PATH first, # even if MSVC is first mentioned in the PATH... # TODO would be nicer if we only did this if cl.exe is indeed first in the PATH if common.is_windows_platform(): cmake_args += ['-DCMAKE_C_COMPILER=cl', '-DCMAKE_CXX_COMPILER=cl'] # TODO this works around a CMake bug https://gitlab.kitware.com/cmake/cmake/issues/20119 cmake_args += ['-DBUILD_WITH_PCH=OFF'] # work around QTBUG-89754 # Qt otherwise adds dependencies on libGLX and libOpenGL cmake_args += ['-DOpenGL_GL_PREFERENCE=LEGACY'] if args.with_docs: cmake_args += ['-DWITH_DOCS=ON'] ide_revision = common.get_commit_SHA(paths.src) if ide_revision: cmake_args += ['-DQTC_PLUGIN_REVISION=' + ide_revision] with open(os.path.join(paths.result, args.name + '.7z.git_sha'), 'w') as f: f.write(ide_revision) if not args.build_type.lower() == 'release' and args.sanitize_flags: cmake_args += ['-DWITH_SANITIZE=ON', '-DSANITIZE_FLAGS=' + ",".join(args.sanitize_flags)] cmake_args += args.config_args common.check_print_call(cmake_args + [paths.src], paths.build) build_args = ['cmake', '--build', '.'] if args.make_args: build_args += ['--'] + args.make_args common.check_print_call(build_args, paths.build) if args.with_docs: common.check_print_call(['cmake', '--build', '.', '--target', 'docs'], paths.build) common.check_print_call(['cmake', '--install', '.', '--prefix', paths.install, '--strip'], paths.build) if args.with_docs: common.check_print_call(['cmake', '--install', '.', '--prefix', paths.install, '--component', 'qch_docs'], paths.build) common.check_print_call(['cmake', '--install', '.', '--prefix', paths.install, '--component', 'html_docs'], paths.build) if args.deploy: common.check_print_call(['cmake', '--install', '.', '--prefix', paths.install, '--component', 'Dependencies'], paths.build) common.check_print_call(['cmake', '--install', '.', '--prefix', paths.dev_install, '--component', 'Devel'], paths.build) if args.with_debug_info: common.check_print_call(['cmake', '--install', '.', '--prefix', paths.debug_install, '--component', 'DebugInfo'], paths.build) def package(args, paths): if not os.path.exists(paths.install): os.makedirs(paths.install) if not os.path.exists(paths.result): os.makedirs(paths.result) if common.is_windows_platform() and args.sign_command: command = shlex.split(args.sign_command) common.check_print_call(command + [paths.install]) zip = common.sevenzip_command(args.zip_threads) common.check_print_call(zip + [os.path.join(paths.result, args.name + '.7z'), '*'], paths.install) if os.path.exists(paths.dev_install): # some plugins might not provide anything in Devel common.check_print_call(zip + [os.path.join(paths.result, args.name + '_dev.7z'), '*'], paths.dev_install) # check for existence - the DebugInfo install target doesn't work for telemetry plugin if args.with_debug_info and os.path.exists(paths.debug_install): common.check_print_call(zip + [os.path.join(paths.result, args.name + '-debug.7z'), '*'], paths.debug_install) if common.is_mac_platform() and common.codesign_call(): if args.keychain_unlock_script: common.check_print_call([args.keychain_unlock_script], paths.install) if os.environ.get('SIGNING_IDENTITY'): signed_install_path = paths.install + '-signed' common.copytree(paths.install, signed_install_path, symlinks=True) zippattern = None if os.path.exists(signed_install_path): apps = [d for d in os.listdir(signed_install_path) if d.endswith('.app')] if apps: zippattern = apps[0] if not zippattern: os.makedirs(signed_install_path) # if nothing was installed zippattern = '*' common.conditional_sign_recursive(signed_install_path, lambda ff: ff.endswith('.dylib')) common.check_print_call(zip + [os.path.join(paths.result, args.name + '-signed.7z'), zippattern], signed_install_path) def get_paths(args): Paths = collections.namedtuple('Paths', ['qt', 'src', 'build', 'qt_creator', 'install', 'dev_install', 'debug_install', 'result']) build_path = os.path.abspath(args.build) install_path = os.path.join(build_path, 'install') result_path = os.path.abspath(args.output_path) if args.output_path else build_path return Paths(qt=os.path.abspath(args.qt_path), src=os.path.abspath(args.src), build=os.path.join(build_path, 'build'), qt_creator=os.path.abspath(args.qtc_path), install=os.path.join(install_path, args.name), dev_install=os.path.join(install_path, args.name + '-dev'), debug_install=os.path.join(install_path, args.name + '-debug'), result=result_path) def main(): args = get_arguments() paths = get_paths(args) build(args, paths) package(args, paths) if __name__ == '__main__': main()