3 # Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 from __future__ import print_function
27 import multiprocessing
29 from pathlib import Path
40 class Error(Exception):
41 def __init__(self, value):
50 Store for Tree objects which re-uses already-created objects
51 and checks for requests for different versions of the same thing.
57 def get(self, name, commit_ish, target, required_by=None):
59 if t.name == name and t.commit_ish == commit_ish and t.target == target:
61 elif t.name == name and t.commit_ish != commit_ish:
62 a = commit_ish if commit_ish is not None else "[Any]"
63 if required_by is not None:
64 a += ' by %s' % required_by
65 b = t.commit_ish if t.commit_ish is not None else "[Any]"
66 if t.required_by is not None:
67 b += ' by %s' % t.required_by
68 raise Error('conflicting versions of %s required (%s versus %s)' % (name, a, b))
70 nt = Tree(name, commit_ish, target, required_by)
74 def add_built(self, name, commit_ish, target):
75 self.trees.append(Tree(name, commit_ish, target, None, built=True))
82 use_git_reference = True
93 def __init__(self, key, default=None):
97 def offer(self, key, value):
102 def __init__(self, key):
106 def offer(self, key, value):
108 self.value = value in ['yes', '1', 'true']
112 self.options = [ Option('mxe_prefix'),
113 Option('git_prefix'),
114 Option('git_reference'),
115 Option('osx_environment_prefix'),
116 Option('osx_sdk_prefix'),
118 Option('osx_intel_deployment'),
119 Option('osx_arm_deployment'),
120 Option('osx_old_deployment'),
121 Option('osx_keychain_file'),
122 Option('osx_keychain_password'),
124 Option('apple_password'),
125 Option('apple_team_id'),
126 BoolOption('docker_sudo'),
127 BoolOption('docker_no_user'),
128 Option('docker_hub_repository'),
129 Option('flatpak_state_dir'),
130 Option('parallel', multiprocessing.cpu_count()),
131 Option('temp', '/var/tmp'),
132 Option('osx_notarytool', ['xcrun', 'notarytool'])]
134 config_dir = '%s/.config' % os.path.expanduser('~')
135 if not os.path.exists(config_dir):
137 config_file = '%s/cdist' % config_dir
138 if not os.path.exists(config_file):
139 f = open(config_file, 'w')
140 for o in self.options:
141 print('# %s ' % o.key, file=f)
143 print('Template config file written to %s; please edit and try again.' % config_file, file=sys.stderr)
146 f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
152 if len(l) > 0 and l[0] == '#':
155 s = l.strip().split()
157 for k in self.options:
160 if not isinstance(self.get('osx_notarytool'), list):
161 self.set('osx_notarytool', [self.get('osx_notarytool')])
165 for o in self.options:
166 if o.key == k and o.value is not None:
171 for o in self.options:
174 raise Error('Required setting %s not found' % k)
178 for o in self.options:
182 if self.get('docker_sudo'):
194 if not globals.quiet:
195 print('\x1b[33m* %s\x1b[0m' % m)
199 print('\x1b[35m* %s\x1b[0m' % m)
201 def escape_spaces(s):
202 return s.replace(' ', '\\ ')
205 """Escape a host:filename string for use with an scp command"""
207 assert(len(s) == 1 or len(s) == 2)
209 return '%s:"\'%s\'"' % (s[0], s[1])
211 return '\"%s\"' % s[0]
214 return '\"%s\"' % n.substr(' ', '\\ ')
217 log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
218 if b.startswith('s3://'):
219 command('s3cmd -P -r put "%s" "%s"' % (a, b))
221 command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
224 log_normal('copy %s -> %s with cwd %s' % (scp_escape(a), scp_escape(b), os.getcwd()))
225 if b.startswith('s3://'):
226 command('s3cmd -P put "%s" "%s"' % (a, b))
232 temp_path = os.path.join(os.path.dirname(path), ".tmp." + os.path.basename(path))
233 command('scp %s %s' % (scp_escape(a), scp_escape(host + ":" + temp_path)))
234 command('ssh %s -- mv "%s" "%s"' % (host, escape_spaces(temp_path), escape_spaces(path)))
236 command('scp %s %s' % (scp_escape(a), scp_escape(b)))
240 Make directories either locally or on a remote host; remotely if
241 d includes a colon, otherwise locally.
243 if d.startswith('s3://'):
244 # No need to create folders on S3
247 if d.find(':') == -1:
255 command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
258 log_normal('remove %s' % a)
262 log_normal('remove %s' % a)
263 shutil.rmtree(a, ignore_errors=True)
268 r = subprocess.run(c, shell=True)
269 if r.returncode != 0:
270 raise Error('command %s failed (%d)' % (c, r.returncode))
271 except Exception as e:
272 raise Error('command %s failed (%s)' % (c, e))
274 def command_and_read(c):
276 p = subprocess.Popen(c.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
277 (out, err) = p.communicate()
278 if p.returncode != 0:
279 raise Error('command %s failed (%s)' % (c, err))
280 return str(out, 'utf-8').splitlines()
282 def read_wscript_variable(directory, variable):
283 f = open('%s/wscript' % directory, 'r')
290 if len(s) == 3 and s[0] == variable:
298 def devel_to_git(git_commit, filename):
299 if git_commit is not None:
300 filename = filename.replace('devel', '-%s' % git_commit)
304 def get_command_line_options(args):
305 """Get the options specified by --option on the command line"""
307 if args.option is not None:
308 for o in args.option:
311 raise Error("Bad option `%s'" % o)
313 options[b[0]] = False
322 def __init__(self, tree):
325 self.cwd = os.getcwd()
326 os.chdir('%s/src/%s' % (self.tree.target.directory, self.tree.name))
327 def __exit__(self, type, value, traceback):
337 Class representing the target that we are building for. This is exposed to cscripts,
338 though not all of it is guaranteed 'API'. cscripts may expect:
340 platform: platform string (e.g. 'windows', 'linux', 'osx')
341 parallel: number of parallel jobs to run
342 directory: directory to work in
343 variables: dict of environment variables
344 debug: True to build a debug version, otherwise False
345 ccache: True to use ccache, False to not
346 set(a, b): set the value of variable 'a' to 'b'
347 unset(a): unset the value of variable 'a'
348 command(c): run the command 'c' in the build environment
352 def __init__(self, platform, directory=None, dependencies_only=False):
354 platform -- platform string (e.g. 'windows', 'linux', 'osx')
355 directory -- directory to work in; if None we will use a temporary directory
356 Temporary directories will be removed after use; specified directories will not.
358 self.platform = platform
359 self.parallel = int(config.get('parallel'))
361 # Environment variables that we will use when we call cscripts
365 # True to build our dependencies ourselves; False if this is taken care
366 # of in some other way
367 self.build_dependencies = True
368 self.dependencies_only = dependencies_only
370 if directory is None:
372 os.makedirs(config.get('temp'))
376 self.directory = tempfile.mkdtemp('', 'tmp', config.get('temp'))
378 self.set('CCACHE_BASEDIR', os.path.realpath(self.directory))
379 self.set('CCACHE_NOHASHDIR', '')
381 self.directory = os.path.realpath(directory)
388 def _cscript_package(self, tree, options):
390 Call package() in the cscript and return what it returns, except that
391 anything not in a list will be put into one.
392 options: from command line
394 if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
395 packages = tree.call('package', tree.version, tree.add_defaults(options))
397 log_normal("Deprecated cscript package() method with no options parameter")
398 packages = tree.call('package', tree.version)
400 return packages if isinstance(packages, list) else [packages]
402 def _copy_packages(self, tree, packages, output_dir):
404 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, p))))
406 def package(self, project, checkout, output_dir, options, notarize):
408 options: from command line
410 tree = self.build(project, checkout, options, for_package=True)
411 p = self._cscript_package(tree, options)
412 self._copy_packages(tree, p, output_dir)
414 def build(self, project, checkout, options, for_package=False):
415 tree = globals.trees.get(project, checkout, self)
416 if self.build_dependencies:
417 tree.build_dependencies(options)
418 if not self.dependencies_only:
419 tree.build(options, for_package=for_package)
422 def test(self, project, checkout, target, test, options):
423 """test is the test case to run, or None"""
424 tree = globals.trees.get(project, checkout, target)
426 with TreeDirectory(tree):
427 if len(inspect.getfullargspec(tree.cscript['test']).args) == 3:
428 return tree.call('test', tree.add_defaults(options), test)
430 log_normal('Deprecated cscript test() method with no options parameter')
431 return tree.call('test', test)
434 self.variables[a] = b
437 del(self.variables[a])
440 return self.variables[a]
442 def append(self, k, v, s):
443 if (not k in self.variables) or len(self.variables[k]) == 0:
444 self.variables[k] = '"%s"' % v
446 e = self.variables[k]
447 if e[0] == '"' and e[-1] == '"':
448 self.variables[k] = '"%s%s%s"' % (e[1:-1], s, v)
450 self.variables[k] = '"%s%s%s"' % (e, s, v)
452 def append_with_space(self, k, v):
453 return self.append(k, v, ' ')
455 def append_with_colon(self, k, v):
456 return self.append(k, v, ':')
458 def variables_string(self, escaped_quotes=False):
460 for k, v in self.variables.items():
462 v = v.replace('"', '\\"')
463 e += '%s=%s ' % (k, v)
468 rmtree(self.directory)
482 class DockerTarget(Target):
483 def __init__(self, platform, directory):
484 super(DockerTarget, self).__init__(platform, directory)
486 self.privileged = False
489 if config.get('docker_no_user'):
491 return '-u %s' % getpass.getuser()
493 def _mount_option(self, d):
494 return '-v %s:%s ' % (os.path.realpath(d), os.path.realpath(d))
497 opts = self._mount_option(self.directory)
498 for m in self.mounts:
499 opts += self._mount_option(m)
500 if config.has('git_reference'):
501 opts += self._mount_option(config.get('git_reference'))
503 opts += '--privileged=true '
505 opts += "-e CCACHE_DIR=/ccache/%s-%d --mount source=ccache,target=/ccache " % (self.image, os.getuid())
509 if config.has('docker_hub_repository'):
510 tag = '%s:%s' % (config.get('docker_hub_repository'), tag)
512 def signal_handler(signum, frame):
513 raise Error('Killed')
514 signal.signal(signal.SIGTERM, signal_handler)
516 self.container = command_and_read('%s run %s %s -itd %s /bin/bash' % (config.docker(), self._user_tag(), opts, tag))[0].strip()
518 def command(self, cmd):
519 dir = os.path.join(self.directory, os.path.relpath(os.getcwd(), self.directory))
520 interactive_flag = '-i ' if sys.stdin.isatty() else ''
521 command('%s exec %s %s -t %s /bin/bash -c \'export %s; cd %s; %s\'' % (config.docker(), self._user_tag(), interactive_flag, self.container, self.variables_string(), dir, cmd))
524 super(DockerTarget, self).cleanup()
525 command('%s kill %s' % (config.docker(), self.container))
528 self.mounts.append(m)
531 class WindowsDockerTarget(DockerTarget):
533 This target exposes the following additional API:
535 bits: bitness of Windows (32 or 64)
536 name: name of our target e.g. x86_64-w64-mingw32.shared
537 environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
538 tool_path: path to 32- and 64-bit tools
540 def __init__(self, bits, directory, environment_version):
541 super(WindowsDockerTarget, self).__init__('windows', directory)
543 # This was used to differentiate "normal" Windows from XP, and is no longer important,
544 # but old cscripts still look for it
547 self.tool_path = '%s/usr/bin' % config.get('mxe_prefix')
549 self.name = 'i686-w64-mingw32.shared'
551 self.name = 'x86_64-w64-mingw32.shared'
552 self.environment_prefix = '%s/usr/%s' % (config.get('mxe_prefix'), self.name)
554 self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.environment_prefix)
555 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
556 self.set('PATH', '%s/bin:%s:%s' % (self.environment_prefix, self.tool_path, os.environ['PATH']))
557 self.set('LD', '%s-ld' % self.name)
558 self.set('RANLIB', '%s-ranlib' % self.name)
559 self.set('WINRC', '%s-windres' % self.name)
560 cxx = '-I%s/include -I%s/include' % (self.environment_prefix, self.directory)
561 link = '-L%s/lib -L%s/lib' % (self.environment_prefix, self.directory)
562 self.set('CXXFLAGS', '"%s"' % cxx)
563 self.set('CPPFLAGS', '')
564 self.set('LINKFLAGS', '"%s"' % link)
565 self.set('LDFLAGS', '"%s"' % link)
567 self.image = 'windows'
568 if environment_version is not None:
569 self.image += '_%s' % environment_version
574 self.set('CC', '"ccache %s-gcc"' % self.name)
575 self.set('CXX', '"ccache %s-g++"' % self.name)
577 self.set('CC', '%s-gcc' % self.name)
578 self.set('CXX', '%s-g++' % self.name)
581 def library_prefix(self):
582 log_normal('Deprecated property library_prefix: use environment_prefix')
583 return self.environment_prefix
586 def windows_prefix(self):
587 log_normal('Deprecated property windows_prefix: use environment_prefix')
588 return self.environment_prefix
591 def mingw_prefixes(self):
592 log_normal('Deprecated property mingw_prefixes: use environment_prefix')
593 return [self.environment_prefix]
596 def mingw_path(self):
597 log_normal('Deprecated property mingw_path: use tool_path')
598 return self.tool_path
601 def mingw_name(self):
602 log_normal('Deprecated property mingw_name: use name')
606 class WindowsNativeTarget(Target):
608 This target exposes the following additional API:
610 bits: bitness of Windows (32 or 64)
611 name: name of our target e.g. x86_64-w64-mingw32.shared
612 environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
614 def __init__(self, directory):
615 super().__init__('windows', directory)
618 self.environment_prefix = config.get('windows_native_environment_prefix')
620 self.set('PATH', '%s/bin:%s' % (self.environment_prefix, os.environ['PATH']))
622 def command(self, cmd):
626 class LinuxTarget(DockerTarget):
628 Build for Linux in a docker container.
629 This target exposes the following additional API:
631 distro: distribution ('debian', 'ubuntu', 'centos' or 'fedora')
632 version: distribution version (e.g. '12.04', '8', '6.5')
633 bits: bitness of the distribution (32 or 64)
634 detail: None or 'appimage' if we are building for appimage
637 def __init__(self, distro, version, bits, directory=None):
638 super(LinuxTarget, self).__init__('linux', directory)
640 self.version = version
644 self.set('CXXFLAGS', '-I%s/include' % self.directory)
645 self.set('CPPFLAGS', '')
646 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
647 self.set('PKG_CONFIG_PATH',
648 '%s/lib/pkgconfig:%s/lib64/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/lib/pkgconfig' % (self.directory, self.directory))
649 self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
651 if self.version is None:
652 self.image = '%s-%s' % (self.distro, self.bits)
654 self.image = '%s-%s-%s' % (self.distro, self.version, self.bits)
657 super(LinuxTarget, self).setup()
659 self.set('CC', '"ccache gcc"')
660 self.set('CXX', '"ccache g++"')
662 def test(self, project, checkout, target, test, options):
663 self.append_with_colon('PATH', '%s/bin' % self.directory)
664 self.append_with_colon('LD_LIBRARY_PATH', '%s/lib' % self.directory)
665 super(LinuxTarget, self).test(project, checkout, target, test, options)
668 class AppImageTarget(LinuxTarget):
669 def __init__(self, work):
670 super(AppImageTarget, self).__init__('ubuntu', '18.04', 64, work)
671 self.detail = 'appimage'
672 self.privileged = True
675 class FlatpakTarget(Target):
676 def __init__(self, project, checkout, work):
677 super(FlatpakTarget, self).__init__('flatpak')
678 self.build_dependencies = False
679 self.project = project
680 self.checkout = checkout
681 # If we use git references we end up with a checkout in one mount trying
682 # to link to the git reference repo in other, which doesn't work.
683 globals.use_git_reference = False
684 if config.has('flatpak_state_dir'):
685 self.mount(config.get('flatpak_state_dir'))
687 def command(self, c):
688 log_normal('host -> %s' % c)
689 command('%s %s' % (self.variables_string(), c))
693 globals.trees.get(self.project, self.checkout, self).checkout_dependencies()
698 def flatpak_builder(self):
699 b = 'flatpak-builder'
700 if config.has('flatpak_state_dir'):
701 b += ' --state-dir=%s' % config.get('flatpak_state_dir')
705 def notarize_dmg(dmg):
707 config.get('osx_notarytool') + [
710 config.get('apple_id'),
712 config.get('apple_password'),
714 config.get('apple_team_id'),
717 ], capture_output=True)
719 last_line = [x.strip() for x in p.stdout.decode('utf-8').splitlines() if x.strip()][-1]
720 if last_line != 'status: Accepted':
721 print("Could not understand notarytool response")
723 print(f"Last line: {last_line}")
724 raise Error('Notarization failed')
726 subprocess.run(['xcrun', 'stapler', 'staple', dmg])
729 class OSXTarget(Target):
730 def __init__(self, directory=None, environment_version=None):
731 super(OSXTarget, self).__init__('osx', directory)
732 self.sdk_prefix = config.get('osx_sdk_prefix')
733 self.environment_prefix = config.get('osx_environment_prefix')
734 if environment_version:
735 self.environment_prefix += '_%s' % environment_version
736 self.apple_id = config.get('apple_id')
737 self.apple_password = config.get('apple_password')
738 self.osx_keychain_file = config.get('osx_keychain_file')
739 self.osx_keychain_password = config.get('osx_keychain_password')
741 def command(self, c):
742 command('%s %s' % (self.variables_string(False), c))
744 def unlock_keychain(self):
745 self.command('security unlock-keychain -p %s %s' % (self.osx_keychain_password, self.osx_keychain_file))
747 def package(self, project, checkout, output_dir, options, notarize):
748 self.unlock_keychain()
749 tree = globals.trees.get(project, checkout, self)
750 with TreeDirectory(tree):
751 p = self._cscript_package_and_notarize(tree, options, self.can_notarize and notarize)
752 self._copy_packages(tree, p, output_dir)
754 def _copy_packages(self, tree, packages, output_dir):
756 dest = os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, p)))
759 def _cscript_package_and_notarize(self, tree, options, notarize):
761 Call package() in the cscript and notarize the .dmgs that are returned, if notarize == True
764 for x in self._cscript_package(tree, options):
765 # Some older cscripts give us the DMG filename and the bundle ID, even though
766 # (since using notarytool instead of altool for notarization) the bundle ID
767 # is no longer necessary. Cope with either type of cscript.
768 dmg = x[0] if isinstance(x, tuple) else x
775 class OSXSingleTarget(OSXTarget):
776 def __init__(self, arch, sdk, deployment, directory=None, can_notarize=True, environment_version=None):
777 super(OSXSingleTarget, self).__init__(directory=directory, environment_version=environment_version)
780 self.deployment = deployment
781 self.can_notarize = can_notarize
782 self.sub_targets = [self]
784 flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (self.sdk_prefix, sdk, arch)
786 host_enviro = '%s/x86_64/%s' % (self.environment_prefix, deployment)
788 host_enviro = '%s/x86_64/10.10' % self.environment_prefix
789 target_enviro = '%s/%s/%s' % (self.environment_prefix, arch, deployment)
791 self.bin = '%s/bin' % target_enviro
793 # Environment variables
794 self.set('CFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, target_enviro, flags))
795 self.set('CPPFLAGS', '')
796 self.set('CXXFLAGS', '"-I%s/include -I%s/include -stdlib=libc++ %s"' % (self.directory, target_enviro, flags))
797 self.set('LDFLAGS', '"-L%s/lib -L%s/lib -stdlib=libc++ %s"' % (self.directory, target_enviro, flags))
798 self.set('LINKFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, target_enviro, flags))
799 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, target_enviro))
800 self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % host_enviro)
801 self.set('MACOSX_DEPLOYMENT_TARGET', self.deployment)
802 self.set('CCACHE_BASEDIR', self.directory)
804 @Target.ccache.setter
806 Target.ccache.fset(self, v)
808 self.set('CC', '"ccache gcc"')
809 self.set('CXX', '"ccache g++"')
811 def package(self, project, checkout, output_dir, options, notarize):
812 tree = self.build(project, checkout, options, for_package=True)
813 super().package(project, checkout, output_dir, options, notarize)
816 class OSXUniversalTarget(OSXTarget):
817 def __init__(self, directory=None, environment_version=None):
818 super(OSXUniversalTarget, self).__init__(directory=directory, environment_version=environment_version)
819 self.sdk = config.get('osx_sdk')
820 self.sub_targets = []
821 for arch, deployment in (('x86_64', config.get('osx_intel_deployment')), ('arm64', config.get('osx_arm_deployment'))):
822 target = OSXSingleTarget(arch, self.sdk, deployment, os.path.join(self.directory, arch, deployment), environment_version=environment_version)
823 target.ccache = self.ccache
824 self.sub_targets.append(target)
825 self.can_notarize = True
827 def package(self, project, checkout, output_dir, options, notarize):
828 for target in self.sub_targets:
829 tree = globals.trees.get(project, checkout, target)
830 tree.build_dependencies(options)
831 tree.build(options, for_package=True)
833 super().package(project, checkout, output_dir, options, notarize)
835 @Target.ccache.setter
837 for target in self.sub_targets:
841 class SourceTarget(Target):
842 """Build a source .tar.bz2 and .zst"""
844 super(SourceTarget, self).__init__('source')
846 def command(self, c):
847 log_normal('host -> %s' % c)
848 command('%s %s' % (self.variables_string(), c))
851 rmtree(self.directory)
853 def package(self, project, checkout, output_dir, options, notarize):
854 tree = globals.trees.get(project, checkout, self)
855 with TreeDirectory(tree):
856 name = read_wscript_variable(os.getcwd(), 'APPNAME')
857 command('./waf dist')
858 bz2 = os.path.abspath('%s-%s.tar.bz2' % (name, tree.version))
859 copyfile(bz2, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, bz2))))
860 command('tar xjf %s' % bz2)
861 command('tar --zstd -cf %s-%s.tar.zst %s-%s' % (name, tree.version, name, tree.version))
862 zstd = os.path.abspath('%s-%s.tar.zst' % (name, tree.version))
863 copyfile(zstd, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, zstd))))
866 class LocalTarget(Target):
867 """Build on the local machine with its environment"""
868 def __init__(self, work, dependencies_only=False):
869 super(LocalTarget, self).__init__('linux', work, dependencies_only=dependencies_only)
870 # Hack around ffmpeg.git which sees that the target isn't windows/osx and then assumes
871 # distro will be there.
875 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
876 self.append_with_colon('LD_LIBRARY_PATH', '%s/lib' % self.directory)
877 self.set('CXXFLAGS', '-I%s/include' % self.directory)
878 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
880 def command(self, c):
881 log_normal('host -> %s' % c)
882 command('%s %s' % (self.variables_string(), c))
885 rmtree(self.directory)
887 # @param s Target string:
889 # or ubuntu-version-{32,64}
890 # or debian-version-{32,64}
891 # or centos-version-{32,64}
892 # or fedora-version-{32,64}
893 # or mageia-version-{32,64}
898 def target_factory(args):
901 if s.startswith('windows-'):
903 if platform.system() == "Windows":
904 target = WindowsNativeTarget(args.work)
906 target = WindowsDockerTarget(int(x[1]), args.work, args.environment_version)
908 raise Error("Bad Windows target name `%s'")
909 elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-') or s.startswith('fedora-') or s.startswith('mageia-'):
912 raise Error("Bad Linux target name `%s'; must be something like ubuntu-16.04-32 (i.e. distro-version-bits)" % s)
913 target = LinuxTarget(p[0], p[1], int(p[2]), args.work)
914 elif s.startswith('arch-'):
917 raise Error("Bad Arch target name `%s'; must be arch-32 or arch-64")
918 target = LinuxTarget(p[0], None, int(p[1]), args.work)
919 elif s == 'raspbian':
920 target = LinuxTarget(s, None, None, args.work)
922 target = OSXUniversalTarget(args.work, environment_version=args.environment_version)
923 elif s == 'osx-intel':
924 target = OSXSingleTarget('x86_64', config.get('osx_sdk'), config.get('osx_intel_deployment'), args.work, environment_version=args.environment_version)
926 target = OSXSingleTarget('x86_64', config.get('osx_sdk'), config.get('osx_old_deployment'), args.work, False, environment_version=args.environment_version)
928 target = SourceTarget()
930 target = FlatpakTarget(args.project, args.checkout, args.work)
931 elif s == 'appimage':
932 target = AppImageTarget(args.work)
934 target = LocalTarget(args.work, args.dependencies_only)
937 raise Error("Bad target `%s'" % s)
939 target.debug = args.debug
940 target.ccache = args.ccache
942 if args.environment is not None:
943 for e in args.environment:
944 target.set(e, os.environ[e])
946 if args.mount is not None:
959 """Description of a tree, which is a checkout of a project,
960 possibly built. This class is never exposed to cscripts.
962 name -- name of git repository (without the .git)
963 commit_ish -- git tag or revision to use
964 target -- target object that we are using
965 version -- version from the wscript (if one is present)
966 commit -- git revision that is actually being used
967 built -- true if the tree has been built yet in this run
968 required_by -- name of the tree that requires this one
971 def __init__(self, name, commit_ish, target, required_by, built=False):
973 self.commit_ish = commit_ish
978 self.required_by = required_by
981 proj = '%s/src/%s' % (target.directory, self.name)
988 redirect = '>/dev/null'
989 if config.has('git_reference') and globals.use_git_reference:
990 ref = '--reference-if-able %s/%s.git' % (config.get('git_reference'), self.name)
993 command('git -c protocol.file.allow=always clone %s %s %s/%s.git %s/src/%s' % (flags, ref, config.get('git_prefix'), self.name, target.directory, self.name))
994 os.chdir('%s/src/%s' % (target.directory, self.name))
996 if self.commit_ish is not None:
997 command('git checkout %s %s %s' % (flags, self.commit_ish, redirect))
998 self.commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
1001 exec(open('%s/cscript' % proj).read(), self.cscript)
1004 # cscript can include submodules = False to stop submodules being fetched
1005 if (not 'submodules' in self.cscript or self.cscript['submodules'] == True) and os.path.exists('.gitmodules'):
1006 command('git submodule --quiet init')
1007 paths = command_and_read('git config --file .gitmodules --get-regexp path')
1008 urls = command_and_read('git config --file .gitmodules --get-regexp url')
1009 for path, url in zip(paths, urls):
1011 if config.has('git_reference') and globals.use_git_reference:
1012 url = url.split(' ')[1]
1013 ref_path = os.path.join(config.get('git_reference'), os.path.basename(url))
1014 if os.path.exists(ref_path):
1015 ref = '--reference %s' % ref_path
1016 path = path.split(' ')[1]
1017 command('git -c protocol.file.allow=always submodule --quiet update %s %s' % (ref, path))
1019 head_tag = command_and_read(f'git -C {proj} tag -l --points-at HEAD')
1021 self.version = head_tag[0][1:]
1023 self.version = command_and_read(f'git -C {proj} rev-parse --short HEAD')[0]
1027 def call(self, function, *args):
1028 with TreeDirectory(self):
1029 return self.cscript[function](self.target, *args)
1031 def add_defaults(self, options):
1032 """Add the defaults from self into a dict options and returns a new dict"""
1033 new_options = copy.copy(options)
1034 if 'option_defaults' in self.cscript:
1035 from_cscript = self.cscript['option_defaults']
1036 if isinstance(from_cscript, dict):
1037 defaults_dict = from_cscript
1039 log_normal("Deprecated cscript option_defaults method; replace with a dict")
1040 defaults_dict = from_cscript()
1041 for k, v in defaults_dict.items():
1042 if not k in new_options:
1046 def dependencies(self, options):
1048 yield details of the dependencies of this tree. Each dependency is returned
1049 as a tuple of (tree, options).
1050 options: either from command line (for top-level tree) or from parent's dependencies() (for other trees)
1052 if not 'dependencies' in self.cscript:
1055 if len(inspect.getfullargspec(self.cscript['dependencies']).args) == 2:
1056 deps = self.call('dependencies', self.add_defaults(options))
1058 log_normal("Deprecated cscript dependencies() method with no options parameter")
1059 deps = self.call('dependencies')
1061 # Loop over our immediate dependencies
1063 dep = globals.trees.get(d[0], d[1], self.target, self.name)
1065 # deps only get their options from the parent's cscript
1066 dep_options = d[2] if len(d) > 2 else {}
1067 for i in dep.dependencies(dep_options):
1069 yield (dep, dep_options)
1071 def checkout_dependencies(self, options={}):
1072 for i in self.dependencies(options):
1075 def build_dependencies(self, options):
1077 Called on the 'main' project tree (-p on the command line) to build all dependencies.
1078 options: either from command line (for top-level tree) or from parent's dependencies() (for other trees)
1080 for dependency, dependency_options in self.dependencies(options):
1081 dependency.build(dependency_options)
1083 def build(self, options, for_package=False):
1085 options: either from command line (for top-level tree) or from parent's dependencies() (for other trees)
1090 log_verbose("Building %s %s %s with %s" % (self.name, self.commit_ish, self.version, self.add_defaults(options)))
1092 variables = copy.copy(self.target.variables)
1094 if not globals.dry_run:
1095 num_args = len(inspect.getfullargspec(self.cscript['build']).args)
1097 self.call('build', self.add_defaults(options), for_package)
1099 self.call('build', self.add_defaults(options))
1103 self.target.variables = variables
1108 # Command-line parser
1112 parser = argparse.ArgumentParser()
1113 parser.add_argument('-p', '--project', help='project name')
1114 parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
1115 parser.add_argument('-o', '--output', help='output directory', default='.')
1116 parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
1117 parser.add_argument('-t', '--target', help='target', action='append')
1118 parser.add_argument('--environment-version', help='version of environment to use')
1119 parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
1120 parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
1121 parser.add_argument('-w', '--work', help='override default work directory')
1122 parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
1123 parser.add_argument('-n', '--dry-run', help='run the process without building anything', action='store_true')
1124 parser.add_argument('-e', '--environment', help='pass the value of the named environment variable into the build', action='append')
1125 parser.add_argument('-m', '--mount', help='mount a given directory in the build environment', action='append')
1126 parser.add_argument('--option', help='set an option for the build (use --option key:value)', action='append')
1127 parser.add_argument('--ccache', help='use ccache', action='store_true')
1128 parser.add_argument('--verbose', help='be verbose', action='store_true')
1130 subparsers = parser.add_subparsers(help='command to run', dest='command')
1131 parser_build = subparsers.add_parser("build", help="build project")
1132 parser_build.add_argument('--dependencies-only', help='only build dependencies', action='store_true')
1133 parser_package = subparsers.add_parser("package", help="build and package project")
1134 parser_package.add_argument('--no-notarize', help='do not notarize .dmg packages', action='store_true')
1135 parser_release = subparsers.add_parser("release", help="release a project using its next version number (adding a tag)")
1136 parser_release.add_argument('--minor', help='minor version number bump', action='store_true')
1137 parser_release.add_argument('--micro', help='micro version number bump', action='store_true')
1138 parser_pot = subparsers.add_parser("pot", help="build the project's .pot files")
1139 parser_manual = subparsers.add_parser("manual", help="build the project's manual")
1140 parser_doxygen = subparsers.add_parser("doxygen", help="build the project's Doxygen documentation")
1141 parser_latest = subparsers.add_parser("latest", help="print out the latest version")
1142 parser_latest.add_argument('--major', help='major version to return', type=int)
1143 parser_latest.add_argument('--minor', help='minor version to return', type=int)
1144 parser_test = subparsers.add_parser("test", help="build the project and run its unit tests")
1145 parser_test.add_argument('--no-implicit-build', help='do not build first', action='store_true')
1146 parser_test.add_argument('--test', help="name of test to run, defaults to all")
1147 parser_shell = subparsers.add_parser("shell", help="start a shell in the project's work directory")
1148 parser_checkout = subparsers.add_parser("checkout", help="check out the project")
1149 parser_revision = subparsers.add_parser("revision", help="print the head git revision number")
1150 parser_dependencies = subparsers.add_parser("dependencies", help="print details of the project's dependencies as a .dot file")
1151 parser_notarize = subparsers.add_parser("notarize", help="notarize .dmgs in a directory")
1152 parser_notarize.add_argument('--dmgs', help='directory containing *.dmg')
1155 args = parser.parse_args()
1157 # Check for incorrect multiple parameters
1158 if args.target is not None:
1159 if len(args.target) > 1:
1160 parser.error('multiple -t options specified')
1163 args.target = args.target[0]
1165 # Override configured stuff
1166 if args.git_prefix is not None:
1167 config.set('git_prefix', args.git_prefix)
1169 if args.output.find(':') == -1:
1170 # This isn't of the form host:path so make it absolute
1171 args.output = os.path.abspath(args.output) + '/'
1173 if args.output[-1] != ':' and args.output[-1] != '/':
1176 # Now, args.output is 'host:', 'host:path/' or 'path/'
1178 if args.work is not None:
1179 args.work = os.path.abspath(args.work)
1180 if not os.path.exists(args.work):
1181 os.makedirs(args.work)
1183 if args.project is None and not args.command in ['shell', 'notarize']:
1184 raise Error('you must specify -p or --project')
1186 globals.quiet = args.quiet
1187 globals.verbose = args.verbose
1188 globals.dry_run = args.dry_run
1190 if args.command == 'build':
1191 if args.target is None:
1192 raise Error('you must specify -t or --target')
1194 target = target_factory(args)
1196 target.build(args.project, args.checkout, get_command_line_options(args))
1201 elif args.command == 'package':
1202 if args.target is None:
1203 raise Error('you must specify -t or --target')
1207 target = target_factory(args)
1209 if target.platform == 'linux' and target.detail != "appimage":
1210 if target.distro != 'arch':
1211 output_dir = os.path.join(args.output, '%s-%s-%d' % (target.distro, target.version, target.bits))
1213 output_dir = os.path.join(args.output, '%s-%d' % (target.distro, target.bits))
1215 output_dir = args.output
1217 makedirs(output_dir)
1218 target.package(args.project, args.checkout, output_dir, get_command_line_options(args), not args.no_notarize)
1220 if target is not None and not args.keep:
1223 elif args.command == 'pot':
1224 target = SourceTarget()
1225 tree = globals.trees.get(args.project, args.checkout, target)
1227 pots = tree.call('make_pot')
1229 copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
1233 elif args.command == 'manual':
1234 target = SourceTarget()
1235 tree = globals.trees.get(args.project, args.checkout, target)
1236 tree.checkout_dependencies()
1238 outs = tree.call('make_manual')
1240 if os.path.isfile(o):
1241 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
1243 copytree(o, '%s%s' % (args.output, os.path.basename(o)))
1247 elif args.command == 'doxygen':
1248 target = SourceTarget()
1249 tree = globals.trees.get(args.project, args.checkout, target)
1251 dirs = tree.call('make_doxygen')
1252 if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
1256 copytree(d, args.output)
1260 elif args.command == 'latest':
1261 target = SourceTarget()
1262 tree = globals.trees.get(args.project, args.checkout, target)
1264 with TreeDirectory(tree):
1265 f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
1268 while latest is None:
1271 m = re.compile(".*\((.*)\).*").match(t)
1273 tags = m.group(1).split(', ')
1278 if len(t) > 0 and t[0] == 'v':
1279 v = t[1:].split('.')
1280 if (args.major is None or int(v[0]) == args.major) and (args.minor is None or int(v[1]) == args.minor):
1283 print('.'.join(latest))
1286 elif args.command == 'test':
1287 if args.target is None:
1288 raise Error('you must specify -t or --target')
1292 target = target_factory(args)
1293 options = get_command_line_options(args)
1294 if args.no_implicit_build:
1295 globals.trees.add_built(args.project, args.checkout, target)
1297 target.build(args.project, args.checkout, options)
1298 target.test(args.project, args.checkout, target, args.test, options)
1300 if target is not None and not args.keep:
1303 elif args.command == 'shell':
1304 if args.target is None:
1305 raise Error('you must specify -t or --target')
1307 target = target_factory(args)
1308 target.command('bash')
1310 elif args.command == 'revision':
1312 target = SourceTarget()
1313 tree = globals.trees.get(args.project, args.checkout, target)
1314 with TreeDirectory(tree):
1315 print(command_and_read('git rev-parse HEAD')[0].strip()[:7])
1318 elif args.command == 'checkout':
1320 if args.output is None:
1321 raise Error('you must specify -o or --output')
1323 target = SourceTarget()
1324 tree = globals.trees.get(args.project, args.checkout, target)
1325 with TreeDirectory(tree):
1326 shutil.copytree('.', args.output)
1329 elif args.command == 'notarize':
1330 if args.dmgs is None:
1331 raise Error('you must specify ---dmgs')
1333 for dmg in Path(args.dmgs).glob('*.dmg'):
1339 print('cdist: %s' % str(e), file=sys.stderr)