3 # Copyright (C) 2012-2020 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
33 import multiprocessing
35 TEMPORARY_DIRECTORY = '/var/tmp'
37 class Error(Exception):
38 def __init__(self, value):
47 Store for Tree objects which re-uses already-created objects
48 and checks for requests for different versions of the same thing.
54 def get(self, name, specifier, target, required_by=None):
56 if t.name == name and t.specifier == specifier and t.target == target:
58 elif t.name == name and t.specifier != specifier:
59 a = specifier if specifier is not None else "[Any]"
60 if required_by is not None:
61 a += ' by %s' % required_by
62 b = t.specifier if t.specifier is not None else "[Any]"
63 if t.required_by is not None:
64 b += ' by %s' % t.required_by
65 raise Error('conflicting versions of %s required (%s versus %s)' % (name, a, b))
67 nt = Tree(name, specifier, target, required_by)
85 def __init__(self, key, default=None):
89 def offer(self, key, value):
93 class BoolOption(object):
94 def __init__(self, key):
98 def offer(self, key, value):
100 self.value = (value == 'yes' or value == '1' or value == 'true')
104 self.options = [ Option('mxe_prefix'),
105 Option('git_prefix'),
106 Option('osx_environment_prefix'),
107 Option('osx_sdk_prefix'),
110 Option('apple_password'),
111 BoolOption('docker_sudo'),
112 BoolOption('docker_no_user'),
113 Option('docker_hub_repository'),
114 Option('flatpak_state_dir'),
115 Option('parallel', multiprocessing.cpu_count()) ]
117 config_dir = '%s/.config' % os.path.expanduser('~')
118 if not os.path.exists(config_dir):
120 config_file = '%s/cdist' % config_dir
121 if not os.path.exists(config_file):
122 f = open(config_file, 'w')
123 for o in self.options:
124 print('# %s ' % o.key, file=f)
126 print('Template config file written to %s; please edit and try again.' % config_file, file=sys.stderr)
130 f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
136 if len(l) > 0 and l[0] == '#':
139 s = l.strip().split()
141 for k in self.options:
147 for o in self.options:
148 if o.key == k and o.value is not None:
153 for o in self.options:
156 raise Error('Required setting %s not found' % k)
160 for o in self.options:
164 if self.get('docker_sudo'):
176 if not globals.quiet:
177 print('\x1b[33m* %s\x1b[0m' % m)
181 print('\x1b[35m* %s\x1b[0m' % m)
183 def escape_spaces(s):
184 return s.replace(' ', '\\ ')
187 """Escape a host:filename string for use with an scp command"""
189 assert(len(s) == 1 or len(s) == 2)
191 return '%s:"\'%s\'"' % (s[0], s[1])
193 return '\"%s\"' % s[0]
196 return '\"%s\"' % n.substr(' ', '\\ ')
199 log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
200 if b.startswith('s3://'):
201 command('s3cmd -P -r put "%s" "%s"' % (a, b))
203 command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
206 log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
207 if b.startswith('s3://'):
208 command('s3cmd -P put "%s" "%s"' % (a, b))
214 temp_path = os.path.join(os.path.dirname(path), ".tmp." + os.path.basename(path))
215 command('scp %s %s' % (scp_escape(a), scp_escape(host + ":" + temp_path)))
216 command('ssh %s -- mv "%s" "%s"' % (host, escape_spaces(temp_path), escape_spaces(path)))
218 command('scp %s %s' % (scp_escape(a), scp_escape(b)))
222 Make directories either locally or on a remote host; remotely if
223 d includes a colon, otherwise locally.
225 if d.startswith('s3://'):
226 # No need to create folders on S3
229 if d.find(':') == -1:
237 command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
240 log_normal('remove %s' % a)
244 log_normal('remove %s' % a)
245 shutil.rmtree(a, ignore_errors=True)
251 raise Error('command %s failed' % c)
253 def command_and_read(c):
255 p = subprocess.Popen(c.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
256 (out, err) = p.communicate()
257 if p.returncode != 0:
258 raise Error('command %s failed (%s)' % (c, err))
259 return str(out, 'utf-8').splitlines()
261 def read_wscript_variable(directory, variable):
262 f = open('%s/wscript' % directory, 'r')
269 if len(s) == 3 and s[0] == variable:
276 def set_version_in_wscript(version):
277 f = open('wscript', 'rw')
278 o = open('wscript.tmp', 'w')
285 if len(s) == 3 and s[0] == "VERSION":
286 print("VERSION = '%s'" % version, file=o)
288 print(l, file=o, end="")
292 os.rename('wscript.tmp', 'wscript')
294 def append_version_to_changelog(version):
296 f = open('ChangeLog', 'r')
298 log_normal('Could not open ChangeLog')
304 f = open('ChangeLog', 'w')
305 now = datetime.datetime.now()
306 f.write('%d-%02d-%02d Carl Hetherington <cth@carlh.net>\n\n\t* Version %s released.\n\n' % (now.year, now.month, now.day, version))
309 def append_version_to_debian_changelog(version):
310 if not os.path.exists('debian'):
311 log_normal('Could not find debian directory')
314 command('dch -b -v %s-1 "New upstream release."' % version)
316 def devel_to_git(git_commit, filename):
317 if git_commit is not None:
318 filename = filename.replace('devel', '-%s' % git_commit)
322 def get_command_line_options(args):
323 """Get the options specified by --option on the command line"""
325 if args.option is not None:
326 for o in args.option:
329 raise Error("Bad option `%s'" % o)
331 options[b[0]] = False
340 def __init__(self, tree):
343 self.cwd = os.getcwd()
344 os.chdir('%s/src/%s' % (self.tree.target.directory, self.tree.name))
345 def __exit__(self, type, value, traceback):
353 def __init__(self, s):
356 if s.startswith("'"):
361 if s.endswith('devel'):
365 if s.endswith('pre'):
369 self.major = int(p[0])
370 self.minor = int(p[1])
372 self.micro = int(p[2])
377 def from_git_tag(cls, tag):
378 bits = tag.split('-')
380 if len(bits) > 1 and int(bits[1]) > 0:
384 def bump_minor(self):
388 def bump_micro(self):
394 def to_release(self):
398 s = '%d.%d.%d' % (self.major, self.minor, self.micro)
408 class Target(object):
410 Class representing the target that we are building for. This is exposed to cscripts,
411 though not all of it is guaranteed 'API'. cscripts may expect:
413 platform: platform string (e.g. 'windows', 'linux', 'osx')
414 parallel: number of parallel jobs to run
415 directory: directory to work in
416 variables: dict of environment variables
417 debug: True to build a debug version, otherwise False
418 ccache: True to use ccache, False to not
419 set(a, b): set the value of variable 'a' to 'b'
420 unset(a): unset the value of variable 'a'
421 command(c): run the command 'c' in the build environment
425 def __init__(self, platform, directory=None):
427 platform -- platform string (e.g. 'windows', 'linux', 'osx')
428 directory -- directory to work in; if None we will use a temporary directory
429 Temporary directories will be removed after use; specified directories will not.
431 self.platform = platform
432 self.parallel = int(config.get('parallel'))
434 # Environment variables that we will use when we call cscripts
438 # True to build our dependencies ourselves; False if this is taken care
439 # of in some other way
440 self.build_dependencies = True
442 if directory is None:
443 self.directory = tempfile.mkdtemp('', 'tmp', TEMPORARY_DIRECTORY)
445 self.set('CCACHE_BASEDIR', os.path.realpath(self.directory))
446 self.set('CCACHE_NOHASHDIR', '')
448 self.directory = directory
455 def package(self, project, checkout, output_dir, options):
456 tree = self.build(project, checkout, options)
457 tree.add_defaults(options)
458 if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
459 packages = tree.call('package', tree.version, options)
461 log_normal("Deprecated cscript package() method with no options parameter")
462 packages = tree.call('package', tree.version)
464 if isinstance(packages, list):
466 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
468 copyfile(packages, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, packages))))
470 def build(self, project, checkout, options):
471 tree = globals.trees.get(project, checkout, self)
472 if self.build_dependencies:
473 tree.build_dependencies(options)
477 def test(self, tree, test, options):
478 """test is the test case to run, or None"""
479 if self.build_dependencies:
480 tree.build_dependencies(options)
482 return tree.call('test', test)
485 self.variables[a] = b
488 del(self.variables[a])
491 return self.variables[a]
493 def append(self, k, v, s):
494 if (not k in self.variables) or len(self.variables[k]) == 0:
495 self.variables[k] = '"%s"' % v
497 e = self.variables[k]
498 if e[0] == '"' and e[-1] == '"':
499 self.variables[k] = '"%s%s%s"' % (e[1:-1], s, v)
501 self.variables[k] = '"%s%s%s"' % (e, s, v)
503 def append_with_space(self, k, v):
504 return self.append(k, v, ' ')
506 def append_with_colon(self, k, v):
507 return self.append(k, v, ':')
509 def variables_string(self, escaped_quotes=False):
511 for k, v in self.variables.items():
513 v = v.replace('"', '\\"')
514 e += '%s=%s ' % (k, v)
519 rmtree(self.directory)
533 class DockerTarget(Target):
534 def __init__(self, platform, directory):
535 super(DockerTarget, self).__init__(platform, directory)
537 self.privileged = False
540 if config.get('docker_no_user'):
542 return '-u %s' % getpass.getuser()
545 opts = '-v %s:%s ' % (self.directory, self.directory)
546 for m in self.mounts:
547 opts += '-v %s:%s ' % (m, m)
549 opts += '--privileged=true '
551 opts += "-e CCACHE_DIR=/ccache --volumes-from ccache-%s" % self.image
554 if config.has('docker_hub_repository'):
555 tag = '%s:%s' % (config.get('docker_hub_repository'), tag)
557 self.container = command_and_read('%s run %s %s -itd %s /bin/bash' % (config.docker(), self._user_tag(), opts, tag))[0].strip()
559 def command(self, cmd):
560 dir = os.path.join(self.directory, os.path.relpath(os.getcwd(), self.directory))
561 interactive_flag = '-i ' if sys.stdin.isatty() else ''
562 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))
565 super(DockerTarget, self).cleanup()
566 command('%s kill %s' % (config.docker(), self.container))
569 self.mounts.append(m)
572 class FlatpakTarget(Target):
573 def __init__(self, project, checkout):
574 super(FlatpakTarget, self).__init__('flatpak')
575 self.build_dependencies = False
576 self.project = project
577 self.checkout = checkout
582 def command(self, cmd):
585 def checkout_dependencies(self):
586 tree = globals.trees.get(self.project, self.checkout, self)
587 return tree.checkout_dependencies()
592 def flatpak_builder(self):
593 b = 'flatpak-builder'
594 if config.has('flatpak_state_dir'):
595 b += ' --state-dir=%s' % config.get('flatpak_state_dir')
599 class WindowsTarget(DockerTarget):
601 This target exposes the following additional API:
603 version: Windows version ('xp' or None)
604 bits: bitness of Windows (32 or 64)
605 name: name of our target e.g. x86_64-w64-mingw32.shared
606 environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
607 tool_path: path to 32- and 64-bit tools
609 def __init__(self, windows_version, bits, directory, environment_version):
610 super(WindowsTarget, self).__init__('windows', directory)
611 self.version = windows_version
614 self.tool_path = '%s/usr/bin' % config.get('mxe_prefix')
616 self.name = 'i686-w64-mingw32.shared'
618 self.name = 'x86_64-w64-mingw32.shared'
619 self.environment_prefix = '%s/usr/%s' % (config.get('mxe_prefix'), self.name)
621 self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.environment_prefix)
622 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
623 self.set('PATH', '%s/bin:%s:%s' % (self.environment_prefix, self.tool_path, os.environ['PATH']))
624 self.set('CC', '%s-gcc' % self.name)
625 self.set('CXX', '%s-g++' % self.name)
626 self.set('LD', '%s-ld' % self.name)
627 self.set('RANLIB', '%s-ranlib' % self.name)
628 self.set('WINRC', '%s-windres' % self.name)
629 cxx = '-I%s/include -I%s/include' % (self.environment_prefix, self.directory)
630 link = '-L%s/lib -L%s/lib' % (self.environment_prefix, self.directory)
631 self.set('CXXFLAGS', '"%s"' % cxx)
632 self.set('CPPFLAGS', '')
633 self.set('LINKFLAGS', '"%s"' % link)
634 self.set('LDFLAGS', '"%s"' % link)
636 self.image = 'windows'
637 if environment_version is not None:
638 self.image += '_%s' % environment_version
641 def library_prefix(self):
642 log_normal('Deprecated property library_prefix: use environment_prefix')
643 return self.environment_prefix
646 def windows_prefix(self):
647 log_normal('Deprecated property windows_prefix: use environment_prefix')
648 return self.environment_prefix
651 def mingw_prefixes(self):
652 log_normal('Deprecated property mingw_prefixes: use environment_prefix')
653 return [self.environment_prefix]
656 def mingw_path(self):
657 log_normal('Deprecated property mingw_path: use tool_path')
658 return self.tool_path
661 def mingw_name(self):
662 log_normal('Deprecated property mingw_name: use name')
666 class LinuxTarget(DockerTarget):
668 Build for Linux in a docker container.
669 This target exposes the following additional API:
671 distro: distribution ('debian', 'ubuntu', 'centos' or 'fedora')
672 version: distribution version (e.g. '12.04', '8', '6.5')
673 bits: bitness of the distribution (32 or 64)
674 detail: None or 'appimage' if we are building for appimage
677 def __init__(self, distro, version, bits, directory=None):
678 super(LinuxTarget, self).__init__('linux', directory)
680 self.version = version
684 self.set('CXXFLAGS', '-I%s/include' % self.directory)
685 self.set('CPPFLAGS', '')
686 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
687 self.set('PKG_CONFIG_PATH',
688 '%s/lib/pkgconfig:%s/lib64/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/lib/pkgconfig' % (self.directory, self.directory))
689 self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
691 if self.version is None:
692 self.image = '%s-%s' % (self.distro, self.bits)
694 self.image = '%s-%s-%s' % (self.distro, self.version, self.bits)
697 super(LinuxTarget, self).setup()
699 self.set('CC', '"ccache gcc"')
700 self.set('CXX', '"ccache g++"')
702 def test(self, tree, test, options):
703 self.append_with_colon('PATH', '%s/bin' % self.directory)
704 self.append_with_colon('LD_LIBRARY_PATH', '%s/lib' % self.directory)
705 super(LinuxTarget, self).test(tree, test, options)
708 class AppImageTarget(LinuxTarget):
709 def __init__(self, work):
710 super(AppImageTarget, self).__init__('ubuntu', '18.04', 64, work)
711 self.detail = 'appimage'
712 self.privileged = True
715 class OSXTarget(Target):
716 def __init__(self, directory=None):
717 super(OSXTarget, self).__init__('osx', directory)
718 self.sdk = config.get('osx_sdk')
719 self.sdk_prefix = config.get('osx_sdk_prefix')
720 self.environment_prefix = config.get('osx_environment_prefix')
721 self.apple_id = config.get('apple_id')
722 self.apple_password = config.get('apple_password')
724 def command(self, c):
725 command('%s %s' % (self.variables_string(False), c))
728 class OSXSingleTarget(OSXTarget):
729 def __init__(self, bits, directory=None):
730 super(OSXSingleTarget, self).__init__(directory)
738 flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (self.sdk_prefix, self.sdk, arch)
739 enviro = '%s/%d' % (config.get('osx_environment_prefix'), bits)
741 # Environment variables
742 self.set('CFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
743 self.set('CPPFLAGS', '')
744 self.set('CXXFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
745 self.set('LDFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
746 self.set('LINKFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
747 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, enviro))
748 self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % enviro)
749 self.set('MACOSX_DEPLOYMENT_TARGET', config.get('osx_sdk'))
750 self.set('CCACHE_BASEDIR', self.directory)
752 @Target.ccache.setter
754 Target.ccache.fset(self, v)
756 self.set('CC', '"ccache gcc"')
757 self.set('CXX', '"ccache g++"')
760 class OSXUniversalTarget(OSXTarget):
761 def __init__(self, directory=None):
762 super(OSXUniversalTarget, self).__init__(directory)
765 def package(self, project, checkout, output_dir, options):
768 target = OSXSingleTarget(b, os.path.join(self.directory, '%d' % b))
769 target.ccache = self.ccache
770 tree = globals.trees.get(project, checkout, target)
771 tree.build_dependencies(options)
774 tree = globals.trees.get(project, checkout, self)
775 with TreeDirectory(tree):
776 if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
777 packages = tree.call('package', tree.version, options)
779 log_normal("Deprecated cscript package() method with no options parameter")
780 packages = tree.call('package', tree.version)
782 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
784 class SourceTarget(Target):
785 """Build a source .tar.bz2"""
787 super(SourceTarget, self).__init__('source')
789 def command(self, c):
790 log_normal('host -> %s' % c)
791 command('%s %s' % (self.variables_string(), c))
794 rmtree(self.directory)
796 def package(self, project, checkout, output_dir, options):
797 tree = globals.trees.get(project, checkout, self)
798 with TreeDirectory(tree):
799 name = read_wscript_variable(os.getcwd(), 'APPNAME')
800 command('./waf dist')
801 p = os.path.abspath('%s-%s.tar.bz2' % (name, tree.version))
802 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
804 # @param s Target string:
806 # or ubuntu-version-{32,64}
807 # or debian-version-{32,64}
808 # or centos-version-{32,64}
809 # or fedora-version-{32,64}
810 # or mageia-version-{32,64}
815 # @param debug True to build with debugging symbols (where possible)
816 def target_factory(args):
819 if s.startswith('windows-'):
822 target = WindowsTarget(None, int(x[1]), args.work, args.environment_version)
824 target = WindowsTarget(x[1], int(x[2]), args.work, args.environment_version)
826 raise Error("Bad Windows target name `%s'")
827 elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-') or s.startswith('fedora-') or s.startswith('mageia-'):
830 raise Error("Bad Linux target name `%s'; must be something like ubuntu-16.04-32 (i.e. distro-version-bits)" % s)
831 target = LinuxTarget(p[0], p[1], int(p[2]), args.work)
832 elif s.startswith('arch-'):
835 raise Error("Bad Arch target name `%s'; must be arch-32 or arch-64")
836 target = LinuxTarget(p[0], None, int(p[1]), args.work)
837 elif s == 'raspbian':
838 target = LinuxTarget(s, None, None, args.work)
839 elif s.startswith('osx-'):
840 target = OSXSingleTarget(int(s.split('-')[1]), args.work)
842 if globals.command == 'build':
843 target = OSXSingleTarget(64, args.work)
845 target = OSXUniversalTarget(args.work)
847 target = SourceTarget()
849 target = FlatpakTarget(args.project, args.checkout)
850 elif s == 'appimage':
851 target = AppImageTarget(args.work)
854 raise Error("Bad target `%s'" % s)
856 target.debug = args.debug
857 target.ccache = args.ccache
859 if args.environment is not None:
860 for e in args.environment:
861 target.set(e, os.environ[e])
863 if args.mount is not None:
876 """Description of a tree, which is a checkout of a project,
877 possibly built. This class is never exposed to cscripts.
879 name -- name of git repository (without the .git)
880 specifier -- git tag or revision to use
881 target -- target object that we are using
882 version -- version from the wscript (if one is present)
883 git_commit -- git revision that is actually being used
884 built -- true if the tree has been built yet in this run
885 required_by -- name of the tree that requires this one
888 def __init__(self, name, specifier, target, required_by):
890 self.specifier = specifier
893 self.git_commit = None
895 self.required_by = required_by
903 redirect = '>/dev/null'
904 command('git clone %s %s/%s.git %s/src/%s' % (flags, config.get('git_prefix'), self.name, target.directory, self.name))
905 os.chdir('%s/src/%s' % (target.directory, self.name))
907 spec = self.specifier
911 command('git checkout %s %s %s' % (flags, spec, redirect))
912 self.git_commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
914 proj = '%s/src/%s' % (target.directory, self.name)
917 exec(open('%s/cscript' % proj).read(), self.cscript)
919 # cscript can include submodules = False to stop submodules being fetched
920 if not 'submodules' in self.cscript or self.cscript['submodules'] == True:
921 command('git submodule init --quiet')
922 command('git submodule update --quiet')
924 if os.path.exists('%s/wscript' % proj):
925 v = read_wscript_variable(proj, "VERSION");
928 self.version = Version(v)
930 tag = command_and_read('git -C %s describe --tags' % proj)[0][1:]
931 self.version = Version.from_git_tag(tag)
935 def call(self, function, *args):
936 with TreeDirectory(self):
937 return self.cscript[function](self.target, *args)
939 def add_defaults(self, options):
940 """Add the defaults from self into a dict options"""
941 if 'option_defaults' in self.cscript:
942 from_cscript = self.cscript['option_defaults']
943 if isinstance(from_cscript, dict):
944 defaults_dict = from_cscript
946 log_normal("Deprecated cscript option_defaults method; replace with a dict")
947 defaults_dict = from_cscript()
948 for k, v in defaults_dict.items():
952 def dependencies(self, options):
954 yield details of the dependencies of this tree. Each dependency is returned
955 as a tuple of (tree, options). The 'options' parameter are the options that
956 we want to force for 'self'.
958 if not 'dependencies' in self.cscript:
961 if len(inspect.getfullargspec(self.cscript['dependencies']).args) == 2:
962 self_options = copy.copy(options)
963 self.add_defaults(self_options)
964 deps = self.call('dependencies', self_options)
966 log_normal("Deprecated cscript dependencies() method with no options parameter")
967 deps = self.call('dependencies')
969 # Loop over our immediate dependencies
971 dep = globals.trees.get(d[0], d[1], self.target, self.name)
973 # deps only get their options from the parent's cscript
974 dep_options = d[2] if len(d) > 2 else {}
975 for i in dep.dependencies(dep_options):
977 yield (dep, dep_options)
979 def checkout_dependencies(self, options={}):
980 for i in self.dependencies(options):
983 def build_dependencies(self, options):
985 Called on the 'main' project tree (-p on the command line) to build all dependencies.
986 'options' will be the ones from the command line.
988 for i in self.dependencies(options):
991 def build(self, options):
995 log_verbose("Building %s %s %s with %s" % (self.name, self.specifier, self.version, options))
997 variables = copy.copy(self.target.variables)
999 options = copy.copy(options)
1000 self.add_defaults(options)
1002 if not globals.dry_run:
1003 if len(inspect.getfullargspec(self.cscript['build']).args) == 2:
1004 self.call('build', options)
1008 self.target.variables = variables
1012 # Command-line parser
1018 "build": "build project",
1019 "package": "package and build project",
1020 "release": "release a project using its next version number (changing wscript and tagging)",
1021 "pot": "build the project's .pot files",
1022 "manual": "build the project's manual",
1023 "doxygen": "build the project's Doxygen documentation",
1024 "latest": "print out the latest version",
1025 "test": "run the project's unit tests",
1026 "shell": "build the project then start a shell",
1027 "checkout": "check out the project",
1028 "revision": "print the head git revision number"
1031 one_of = "Command is one of:\n"
1033 for k, v in commands.items():
1034 one_of += "\t%s\t%s\n" % (k, v)
1037 parser = argparse.ArgumentParser()
1038 parser.add_argument('command', help=summary)
1039 parser.add_argument('-p', '--project', help='project name')
1040 parser.add_argument('--minor', help='minor version number bump', action='store_true')
1041 parser.add_argument('--micro', help='micro version number bump', action='store_true')
1042 parser.add_argument('--latest-major', help='major version to return with latest', type=int)
1043 parser.add_argument('--latest-minor', help='minor version to return with latest', type=int)
1044 parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
1045 parser.add_argument('-o', '--output', help='output directory', default='.')
1046 parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
1047 parser.add_argument('-t', '--target', help='target', action='append')
1048 parser.add_argument('--environment-version', help='version of environment to use')
1049 parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
1050 parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
1051 parser.add_argument('-w', '--work', help='override default work directory')
1052 parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
1053 parser.add_argument('--test', help="name of test to run (with `test'), defaults to all")
1054 parser.add_argument('-n', '--dry-run', help='run the process without building anything', action='store_true')
1055 parser.add_argument('-e', '--environment', help='pass the value of the named environment variable into the build', action='append')
1056 parser.add_argument('-m', '--mount', help='mount a given directory in the build environment', action='append')
1057 parser.add_argument('--no-version-commit', help="use just tags for versioning, don't modify wscript, ChangeLog etc.", action='store_true')
1058 parser.add_argument('--option', help='set an option for the build (use --option key:value)', action='append')
1059 parser.add_argument('--ccache', help='use ccache', action='store_true')
1060 parser.add_argument('--verbose', help='be verbose', action='store_true')
1062 args = parser.parse_args()
1064 # Check for incorrect multiple parameters
1065 if args.target is not None:
1066 if len(args.target) > 1:
1067 parser.error('multiple -t options specified')
1070 args.target = args.target[0]
1072 # Override configured stuff
1073 if args.git_prefix is not None:
1074 config.set('git_prefix', args.git_prefix)
1076 if args.output.find(':') == -1:
1077 # This isn't of the form host:path so make it absolute
1078 args.output = os.path.abspath(args.output) + '/'
1080 if args.output[-1] != ':' and args.output[-1] != '/':
1083 # Now, args.output is 'host:', 'host:path/' or 'path/'
1085 if args.work is not None:
1086 args.work = os.path.abspath(args.work)
1087 if not os.path.exists(args.work):
1088 os.makedirs(args.work)
1090 if args.project is None and args.command != 'shell':
1091 raise Error('you must specify -p or --project')
1093 globals.quiet = args.quiet
1094 globals.verbose = args.verbose
1095 globals.command = args.command
1096 globals.dry_run = args.dry_run
1098 if not globals.command in commands:
1099 e = 'command must be one of:\n' + one_of
1100 raise Error('command must be one of:\n%s' % one_of)
1102 if globals.command == 'build':
1103 if args.target is None:
1104 raise Error('you must specify -t or --target')
1106 target = target_factory(args)
1107 target.build(args.project, args.checkout, get_command_line_options(args))
1111 elif globals.command == 'package':
1112 if args.target is None:
1113 raise Error('you must specify -t or --target')
1117 target = target_factory(args)
1119 if target.platform == 'linux' and target.detail != "appimage":
1120 if target.distro != 'arch':
1121 output_dir = os.path.join(args.output, '%s-%s-%d' % (target.distro, target.version, target.bits))
1123 output_dir = os.path.join(args.output, '%s-%d' % (target.distro, target.bits))
1125 output_dir = args.output
1127 makedirs(output_dir)
1128 target.package(args.project, args.checkout, output_dir, get_command_line_options(args))
1130 if target is not None and not args.keep:
1134 if target is not None and not args.keep:
1137 elif globals.command == 'release':
1138 if args.minor is False and args.micro is False:
1139 raise Error('you must specify --minor or --micro')
1141 target = SourceTarget()
1142 tree = globals.trees.get(args.project, args.checkout, target)
1144 version = tree.version
1145 version.to_release()
1147 version.bump_minor()
1149 version.bump_micro()
1151 with TreeDirectory(tree):
1152 if not args.no_version_commit:
1153 set_version_in_wscript(version)
1154 append_version_to_changelog(version)
1155 append_version_to_debian_changelog(version)
1156 command('git commit -a -m "Bump version"')
1158 command('git tag -m "v%s" v%s' % (version, version))
1160 if not args.no_version_commit:
1162 set_version_in_wscript(version)
1163 command('git commit -a -m "Bump version"')
1166 command('git push --tags')
1170 elif globals.command == 'pot':
1171 target = SourceTarget()
1172 tree = globals.trees.get(args.project, args.checkout, target)
1174 pots = tree.call('make_pot')
1176 copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
1180 elif globals.command == 'manual':
1181 target = SourceTarget()
1182 tree = globals.trees.get(args.project, args.checkout, target)
1184 outs = tree.call('make_manual')
1186 if os.path.isfile(o):
1187 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
1189 copytree(o, '%s%s' % (args.output, os.path.basename(o)))
1193 elif globals.command == 'doxygen':
1194 target = SourceTarget()
1195 tree = globals.trees.get(args.project, args.checkout, target)
1197 dirs = tree.call('make_doxygen')
1198 if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
1202 copytree(d, args.output)
1206 elif globals.command == 'latest':
1207 target = SourceTarget()
1208 tree = globals.trees.get(args.project, args.checkout, target)
1210 with TreeDirectory(tree):
1211 f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
1214 while latest is None:
1217 m = re.compile(".*\((.*)\).*").match(t)
1219 tags = m.group(1).split(', ')
1224 if len(t) > 0 and t[0] == 'v':
1226 if (args.latest_major is None or v.major == args.latest_major) and (args.latest_minor is None or v.minor == args.latest_minor):
1232 elif globals.command == 'test':
1233 if args.target is None:
1234 raise Error('you must specify -t or --target')
1238 target = target_factory(args)
1239 tree = globals.trees.get(args.project, args.checkout, target)
1240 with TreeDirectory(tree):
1241 target.test(tree, args.test, get_command_line_options(args))
1243 if target is not None and not args.keep:
1247 if target is not None and not args.keep:
1250 elif globals.command == 'shell':
1251 if args.target is None:
1252 raise Error('you must specify -t or --target')
1254 target = target_factory(args)
1255 target.command('bash')
1257 elif globals.command == 'revision':
1259 target = SourceTarget()
1260 tree = globals.trees.get(args.project, args.checkout, target)
1261 with TreeDirectory(tree):
1262 print(command_and_read('git rev-parse HEAD')[0].strip()[:7])
1265 elif globals.command == 'checkout':
1267 if args.output is None:
1268 raise Error('you must specify -o or --output')
1270 target = SourceTarget()
1271 tree = globals.trees.get(args.project, args.checkout, target)
1272 with TreeDirectory(tree):
1273 shutil.copytree('.', args.output)
1277 raise Error('invalid command %s' % globals.command)
1282 print('cdist: %s' % str(e), file=sys.stderr)