1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
# Copyright (c) 2019 Egor Tensin <Egor.Tensin@gmail.com>
# This file is part of the "cmake-common" project.
# For details, see https://github.com/egor-tensin/cmake-common.
# Distributed under the MIT License.
R'''Build a CMake project.
This script is used basically to invoke the CMake executable in a
cross-platform way (provided the platform has Python 3, of course). The
motivation was to merge my Travis and AppVeyor build scripts (largely similar,
but written in bash and PowerShell, respectively).
A simple usage example:
$ python -m project.cmake.build --configuration Release --install path/to/somewhere -- examples/simple
...
$ ./path/to/somewhere/bin/foo
foo
Picking the target platform is build system-specific. On Visual Studio, pass
the target platform using the `-A` flag like this:
> python -m project.cmake.build --install path\to\somewhere -- examples\simple -A Win32
...
Using GCC-like compilers, the best way is to use CMake toolchain files (see
toolchains/cmake in this repository for examples).
$ python -m project.cmake.build --install path/to/somewhere -- examples/simple -D CMAKE_TOOLCHAIN_FILE="$( pwd )/toolchains/mingw-x86.cmake"
...
'''
import argparse
from contextlib import contextmanager
import logging
import os
import os.path
import sys
import tempfile
from project.configuration import Configuration
from project.utils import normalize_path, run, setup_logging
DEFAULT_CONFIGURATION = Configuration.DEBUG
def run_cmake(cmake_args):
return run(['cmake'] + cmake_args)
class GenerationPhase:
def __init__(self, src_dir, build_dir, install_dir=None,
configuration=DEFAULT_CONFIGURATION, cmake_args=None):
src_dir = normalize_path(src_dir)
build_dir = normalize_path(build_dir)
if install_dir is not None:
install_dir = normalize_path(install_dir)
cmake_args = cmake_args or []
self.src_dir = src_dir
self.build_dir = build_dir
self.install_dir = install_dir
self.configuration = configuration
self.cmake_args = cmake_args
def _cmake_args(self):
result = []
if self.install_dir is not None:
result += ['-D', f'CMAKE_INSTALL_PREFIX={self.install_dir}']
result += ['-D', f'CMAKE_BUILD_TYPE={self.configuration}']
result += self.cmake_args
result += [f'-B{self.build_dir}', f'-H{self.src_dir}']
return result
def run(self):
run_cmake(self._cmake_args())
class BuildPhase:
def __init__(self, build_dir, install_dir=None,
configuration=DEFAULT_CONFIGURATION):
build_dir = normalize_path(build_dir)
self.build_dir = build_dir
self.install_dir = install_dir
self.configuration = configuration
def _cmake_args(self):
result = ['--build', self.build_dir]
result += ['--config', str(self.configuration)]
if self.install_dir is not None:
result += ['--target', 'install']
return result
def run(self):
run_cmake(self._cmake_args())
class BuildParameters:
def __init__(self, src_dir, build_dir=None, install_dir=None,
configuration=DEFAULT_CONFIGURATION, cmake_args=None):
src_dir = normalize_path(src_dir)
if build_dir is not None:
build_dir = normalize_path(build_dir)
if install_dir is not None:
install_dir = normalize_path(install_dir)
cmake_args = cmake_args or []
self.src_dir = src_dir
self.build_dir = build_dir
self.install_dir = install_dir
self.configuration = configuration
self.cmake_args = cmake_args
@staticmethod
def from_args(args):
return BuildParameters(**vars(args))
@contextmanager
def create_build_dir(self):
if self.build_dir is not None:
logging.info('Build directory: %s', self.build_dir)
yield self.build_dir
return
with tempfile.TemporaryDirectory(dir=os.path.dirname(self.src_dir)) as build_dir:
logging.info('Build directory: %s', build_dir)
try:
yield build_dir
finally:
logging.info('Removing build directory: %s', build_dir)
return
def build(params):
with params.create_build_dir() as build_dir:
gen_phase = GenerationPhase(params.src_dir, build_dir,
install_dir=params.install_dir,
configuration=params.configuration,
cmake_args=params.cmake_args)
gen_phase.run()
build_phase = BuildPhase(build_dir, install_dir=params.install_dir,
configuration=params.configuration)
build_phase.run()
def _parse_args(argv=None):
if argv is None:
argv = sys.argv[1:]
logging.info('Command line arguments: %s', argv)
parser = argparse.ArgumentParser(
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument('--build', metavar='DIR', dest='build_dir',
type=normalize_path,
help='build directory (temporary directory unless specified)')
parser.add_argument('--install', metavar='DIR', dest='install_dir',
type=normalize_path,
help='install directory')
configuration_options = '/'.join(map(str, Configuration.all()))
parser.add_argument('--configuration', metavar='CONFIG',
type=Configuration.parse, default=DEFAULT_CONFIGURATION,
help=f'build configuration ({configuration_options})')
parser.add_argument('src_dir', metavar='DIR',
type=normalize_path,
help='source directory')
parser.add_argument('cmake_args', metavar='CMAKE_ARG',
nargs='*', default=[],
help='additional CMake arguments, to be passed verbatim')
return parser.parse_args(argv)
def main(argv=None):
with setup_logging():
build(BuildParameters.from_args(_parse_args(argv)))
if __name__ == '__main__':
main()
|
