3 # Copyright 2001 Google Inc. All Rights Reserved.
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 """Script that generates the build.ninja for ninja itself.
19 Projects that use ninja themselves should either write a similar script
20 or use a meta-build system that supports Ninja output."""
22 from __future__ import print_function
24 from optparse import OptionParser
27 sys.path.insert(0, 'misc')
31 parser = OptionParser()
32 platforms = ['linux', 'freebsd', 'solaris', 'mingw', 'windows']
33 profilers = ['gmon', 'pprof']
34 parser.add_option('--platform',
35 help='target platform (' + '/'.join(platforms) + ')',
37 parser.add_option('--host',
38 help='host platform (' + '/'.join(platforms) + ')',
40 parser.add_option('--debug', action='store_true',
41 help='enable debugging extras',)
42 parser.add_option('--profile', metavar='TYPE',
44 help='enable profiling (' + '/'.join(profilers) + ')',)
45 parser.add_option('--with-gtest', metavar='PATH',
46 help='use gtest unpacked in directory PATH')
47 parser.add_option('--with-python', metavar='EXE',
48 help='use EXE as the Python interpreter',
49 default=os.path.basename(sys.executable))
50 (options, args) = parser.parse_args()
52 print('ERROR: extra unparsed command-line arguments:', args)
55 platform = options.platform
57 platform = sys.platform
58 if platform.startswith('linux'):
60 elif platform.startswith('freebsd'):
62 elif platform.startswith('solaris'):
64 elif platform.startswith('mingw'):
66 elif platform.startswith('win'):
68 host = options.host or platform
70 BUILD_FILENAME = 'build.ninja'
71 buildfile = open(BUILD_FILENAME, 'w')
72 n = ninja_syntax.Writer(buildfile)
73 n.comment('This file is used to build ninja itself.')
74 n.comment('It is generated by ' + os.path.basename(__file__) + '.')
77 n.comment('The arguments passed to configure.py, for rerunning it.')
78 n.variable('configure_args', ' '.join(sys.argv[1:]))
79 env_keys = set(['CXX', 'AR', 'CFLAGS', 'LDFLAGS'])
80 configure_env = dict((k, os.environ[k]) for k in os.environ if k in env_keys)
82 config_str = ' '.join([k + '=' + configure_env[k] for k in configure_env])
83 n.variable('configure_env', config_str + '$ ')
86 CXX = configure_env.get('CXX', 'g++')
88 if platform == 'windows':
93 return os.path.join('src', filename)
95 return os.path.join('$builddir', filename)
97 return os.path.join('doc', filename)
98 def cc(name, **kwargs):
99 return n.build(built(name + objext), 'cxx', src(name + '.c'), **kwargs)
100 def cxx(name, **kwargs):
101 return n.build(built(name + objext), 'cxx', src(name + '.cc'), **kwargs)
103 if platform in ('mingw', 'windows'):
105 n.build(name, 'phony', exe)
109 n.variable('builddir', 'build')
110 n.variable('cxx', CXX)
111 if platform == 'windows':
112 n.variable('ar', 'link')
114 n.variable('ar', configure_env.get('AR', 'ar'))
116 if platform == 'windows':
117 cflags = ['/nologo', # Don't print startup banner.
118 '/Zi', # Create pdb with debug info.
119 '/W4', # Highest warning level.
120 '/WX', # Warnings as errors.
121 '/wd4530', '/wd4100', '/wd4706',
122 '/wd4512', '/wd4800', '/wd4702', '/wd4819',
123 # Disable warnings about passing "this" during initialization.
125 '/GR-', # Disable RTTI.
126 # Disable size_t -> int truncation warning.
127 # We never have strings or arrays larger than 2**31.
129 '/DNOMINMAX', '/D_CRT_SECURE_NO_WARNINGS',
130 '/DNINJA_PYTHON="%s"' % options.with_python]
131 ldflags = ['/DEBUG', '/libpath:$builddir']
132 if not options.debug:
133 cflags += ['/Ox', '/DNDEBUG', '/GL']
134 ldflags += ['/LTCG', '/OPT:REF', '/OPT:ICF']
136 cflags = ['-g', '-Wall', '-Wextra',
138 '-Wno-unused-parameter',
141 '-fvisibility=hidden', '-pipe',
142 '-Wno-missing-field-initializers',
143 '-DNINJA_PYTHON="%s"' % options.with_python]
145 cflags += ['-D_GLIBCXX_DEBUG', '-D_GLIBCXX_DEBUG_PEDANTIC']
146 cflags.remove('-fno-rtti') # Needed for above pedanticness.
148 cflags += ['-O2', '-DNDEBUG']
149 if 'clang' in os.path.basename(CXX):
150 cflags += ['-fcolor-diagnostics']
151 if platform == 'mingw':
152 cflags += ['-D_WIN32_WINNT=0x0501']
153 ldflags = ['-L$builddir']
156 if platform == 'mingw':
157 cflags.remove('-fvisibility=hidden');
158 ldflags.append('-static')
159 elif platform == 'sunos5':
160 cflags.remove('-fvisibility=hidden')
161 elif platform == 'windows':
164 if options.profile == 'gmon':
166 ldflags.append('-pg')
167 elif options.profile == 'pprof':
168 libs.append('-lprofiler')
170 def shell_escape(str):
171 """Escape str such that it's interpreted as a single argument by
174 # This isn't complete, but it's just enough to make NINJA_PYTHON work.
175 if platform in ('windows', 'mingw'):
178 return "'%s'" % str.replace("'", "\\'")
181 if 'CFLAGS' in configure_env:
182 cflags.append(configure_env['CFLAGS'])
183 n.variable('cflags', ' '.join(shell_escape(flag) for flag in cflags))
184 if 'LDFLAGS' in configure_env:
185 ldflags.append(configure_env['LDFLAGS'])
186 n.variable('ldflags', ' '.join(shell_escape(flag) for flag in ldflags))
189 if platform == 'windows':
191 command='$cxx /showIncludes $cflags -c $in /Fo$out',
192 description='CXX $out',
196 command='$cxx -MMD -MT $out -MF $out.d $cflags -c $in -o $out',
199 description='CXX $out')
202 if host == 'windows':
204 command='lib /nologo /ltcg /out:$out $in',
205 description='LIB $out')
206 elif host == 'mingw':
208 command='cmd /c $ar cqs $out.tmp $in && move /Y $out.tmp $out',
209 description='AR $out')
212 command='rm -f $out && $ar crs $out $in',
213 description='AR $out')
216 if platform == 'windows':
218 command='$cxx $in $libs /nologo /link $ldflags /out:$out',
219 description='LINK $out')
222 command='$cxx $ldflags -o $out $in $libs',
223 description='LINK $out')
228 if platform not in ('solaris', 'mingw', 'windows'):
229 n.comment('browse_py.h is used to inline browse.py.')
231 command='src/inline.sh $varname < $in > $out',
232 description='INLINE $out')
233 n.build(built('browse_py.h'), 'inline', src('browse.py'),
234 implicit='src/inline.sh',
235 variables=[('varname', 'kBrowsePy')])
238 objs += cxx('browse', order_only=built('browse_py.h'))
241 n.comment('the depfile parser and ninja lexers are generated using re2c.')
245 proc = subprocess.Popen(['re2c', '-V'], stdout=subprocess.PIPE)
246 return int(proc.communicate()[0], 10) >= 1103
251 command='re2c -b -i --no-generation-date -o $out $in',
252 description='RE2C $out')
253 # Generate the .cc files in the source directory so we can check them in.
254 n.build(src('depfile_parser.cc'), 're2c', src('depfile_parser.in.cc'))
255 n.build(src('lexer.cc'), 're2c', src('lexer.in.cc'))
257 print("warning: A compatible version of re2c (>= 0.11.3) was not found; "
258 "changes to src/*.in.cc will not affect your build.")
261 n.comment('Core source files all build into ninja library.')
262 for name in ['build',
281 if platform in ('mingw', 'windows'):
282 for name in ['subprocess-win32',
283 'includes_normalize-win32',
285 'msvc_helper_main-win32']:
287 if platform == 'windows':
288 objs += cxx('minidump-win32')
291 objs += cxx('subprocess-posix')
292 if platform == 'windows':
293 ninja_lib = n.build(built('ninja.lib'), 'ar', objs)
295 ninja_lib = n.build(built('libninja.a'), 'ar', objs)
298 if platform == 'windows':
299 libs.append('ninja.lib')
301 libs.append('-lninja')
305 n.comment('Main executable is library plus main() function.')
307 ninja = n.build(binary('ninja'), 'link', objs, implicit=ninja_lib,
308 variables=[('libs', libs)])
312 n.comment('Tests all build into ninja_test executable.')
315 test_cflags = cflags + ['-DGTEST_HAS_RTTI=0']
319 if options.with_gtest:
320 path = options.with_gtest
322 gtest_all_incs = '-I%s -I%s' % (path, os.path.join(path, 'include'))
323 if platform == 'windows':
324 gtest_cflags = '/nologo /EHsc /Zi ' + gtest_all_incs
326 gtest_cflags = '-fvisibility=hidden ' + gtest_all_incs
327 objs += n.build(built('gtest-all' + objext), 'cxx',
328 os.path.join(path, 'src', 'gtest-all.cc'),
329 variables=[('cflags', gtest_cflags)])
331 test_cflags.append('-I%s' % os.path.join(path, 'include'))
333 # Use gtest from system.
334 if platform == 'windows':
335 test_libs.extend(['gtest_main.lib', 'gtest.lib'])
337 test_libs.extend(['-lgtest_main', '-lgtest'])
339 n.variable('test_cflags', test_cflags)
340 for name in ['build_log_test',
343 'depfile_parser_test',
345 'disk_interface_test',
346 'edit_distance_test',
349 'manifest_parser_test',
355 objs += cxx(name, variables=[('cflags', '$test_cflags')])
356 if platform in ('windows', 'mingw'):
357 for name in ['includes_normalize_test', 'msvc_helper_test']:
358 objs += cxx(name, variables=[('cflags', test_cflags)])
360 if platform != 'mingw' and platform != 'windows':
361 test_libs.append('-lpthread')
362 ninja_test = n.build(binary('ninja_test'), 'link', objs, implicit=ninja_lib,
363 variables=[('ldflags', test_ldflags),
364 ('libs', test_libs)])
366 all_targets += ninja_test
369 n.comment('Ancillary executables.')
370 objs = cxx('parser_perftest')
371 all_targets += n.build(binary('parser_perftest'), 'link', objs,
372 implicit=ninja_lib, variables=[('libs', libs)])
373 objs = cxx('build_log_perftest')
374 all_targets += n.build(binary('build_log_perftest'), 'link', objs,
375 implicit=ninja_lib, variables=[('libs', libs)])
376 objs = cxx('canon_perftest')
377 all_targets += n.build(binary('canon_perftest'), 'link', objs,
378 implicit=ninja_lib, variables=[('libs', libs)])
379 objs = cxx('hash_collision_bench')
380 all_targets += n.build(binary('hash_collision_bench'), 'link', objs,
381 implicit=ninja_lib, variables=[('libs', libs)])
384 n.comment('Generate a graph using the "graph" tool.')
386 command='./ninja -t graph all > $out')
388 command='dot -Tpng $in > $out')
389 dot = n.build(built('graph.dot'), 'gendot', ['ninja', 'build.ninja'])
390 n.build('graph.png', 'gengraph', dot)
393 n.comment('Generate the manual using asciidoc.')
395 command='asciidoc -b docbook -d book -o $out $in',
396 description='ASCIIDOC $out')
398 command='xsltproc --nonet doc/docbook.xsl $in > $out',
399 description='XSLTPROC $out')
400 xml = n.build(built('manual.xml'), 'asciidoc', doc('manual.asciidoc'))
401 manual = n.build(doc('manual.html'), 'xsltproc', xml,
402 implicit=doc('style.css'))
403 n.build('manual', 'phony',
407 n.comment('Generate Doxygen.')
409 command='doxygen $in',
410 description='DOXYGEN $in')
411 n.variable('doxygen_mainpage_generator',
412 src('gen_doxygen_mainpage.sh'))
413 n.rule('doxygen_mainpage',
414 command='$doxygen_mainpage_generator $in > $out',
415 description='DOXYGEN_MAINPAGE $out')
416 mainpage = n.build(built('doxygen_mainpage'), 'doxygen_mainpage',
417 ['README', 'COPYING'],
418 implicit=['$doxygen_mainpage_generator'])
419 n.build('doxygen', 'doxygen', doc('doxygen.config'),
424 n.comment('Regenerate build files if build script changes.')
426 command='${configure_env}%s configure.py $configure_args' %
429 n.build('build.ninja', 'configure',
430 implicit=['configure.py', os.path.normpath('misc/ninja_syntax.py')])
437 n.comment('Packaging')
439 command="misc/packaging/rpmbuild.sh",
440 description='Building rpms..')
441 n.build('rpm', 'rpmbuild')
444 n.build('all', 'phony', all_targets)
446 print('wrote %s.' % BUILD_FILENAME)