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 parser.add_option('--with-ninja', metavar='NAME',
51 help="name for ninja binary for -t msvc (MSVC only)",
53 (options, args) = parser.parse_args()
55 print('ERROR: extra unparsed command-line arguments:', args)
58 platform = options.platform
60 platform = sys.platform
61 if platform.startswith('linux'):
63 elif platform.startswith('freebsd'):
65 elif platform.startswith('solaris'):
67 elif platform.startswith('mingw'):
69 elif platform.startswith('win'):
71 host = options.host or platform
73 BUILD_FILENAME = 'build.ninja'
74 buildfile = open(BUILD_FILENAME, 'w')
75 n = ninja_syntax.Writer(buildfile)
76 n.comment('This file is used to build ninja itself.')
77 n.comment('It is generated by ' + os.path.basename(__file__) + '.')
80 n.comment('The arguments passed to configure.py, for rerunning it.')
81 n.variable('configure_args', ' '.join(sys.argv[1:]))
82 env_keys = set(['CXX', 'AR', 'CFLAGS', 'LDFLAGS'])
83 configure_env = dict((k, os.environ[k]) for k in os.environ if k in env_keys)
85 config_str = ' '.join([k + '=' + configure_env[k] for k in configure_env])
86 n.variable('configure_env', config_str + '$ ')
89 CXX = configure_env.get('CXX', 'g++')
91 if platform == 'windows':
96 return os.path.join('src', filename)
98 return os.path.join('$builddir', filename)
100 return os.path.join('doc', filename)
101 def cc(name, **kwargs):
102 return n.build(built(name + objext), 'cxx', src(name + '.c'), **kwargs)
103 def cxx(name, **kwargs):
104 return n.build(built(name + objext), 'cxx', src(name + '.cc'), **kwargs)
106 if platform in ('mingw', 'windows'):
108 n.build(name, 'phony', exe)
112 n.variable('builddir', 'build')
113 n.variable('cxx', CXX)
114 if platform == 'windows':
115 n.variable('ar', 'link')
117 n.variable('ar', configure_env.get('AR', 'ar'))
119 if platform == 'windows':
120 cflags = ['/nologo', # Don't print startup banner.
121 '/Zi', # Create pdb with debug info.
122 '/W4', # Highest warning level.
123 '/WX', # Warnings as errors.
124 '/wd4530', '/wd4100', '/wd4706',
125 '/wd4512', '/wd4800', '/wd4702', '/wd4819',
126 # Disable warnings about passing "this" during initialization.
128 '/GR-', # Disable RTTI.
129 # Disable size_t -> int truncation warning.
130 # We never have strings or arrays larger than 2**31.
132 '/DNOMINMAX', '/D_CRT_SECURE_NO_WARNINGS',
133 '/DNINJA_PYTHON="%s"' % options.with_python]
134 ldflags = ['/DEBUG', '/libpath:$builddir']
135 if not options.debug:
136 cflags += ['/Ox', '/DNDEBUG', '/GL']
137 ldflags += ['/LTCG', '/OPT:REF', '/OPT:ICF']
139 cflags = ['-g', '-Wall', '-Wextra',
141 '-Wno-unused-parameter',
144 '-fvisibility=hidden', '-pipe',
145 '-Wno-missing-field-initializers',
146 '-DNINJA_PYTHON="%s"' % options.with_python]
148 cflags += ['-D_GLIBCXX_DEBUG', '-D_GLIBCXX_DEBUG_PEDANTIC']
149 cflags.remove('-fno-rtti') # Needed for above pedanticness.
151 cflags += ['-O2', '-DNDEBUG']
152 if 'clang' in os.path.basename(CXX):
153 cflags += ['-fcolor-diagnostics']
154 if platform == 'mingw':
155 cflags += ['-D_WIN32_WINNT=0x0501']
156 ldflags = ['-L$builddir']
159 if platform == 'mingw':
160 cflags.remove('-fvisibility=hidden');
161 ldflags.append('-static')
162 elif platform == 'sunos5':
163 cflags.remove('-fvisibility=hidden')
164 elif platform == 'windows':
167 if options.profile == 'gmon':
169 ldflags.append('-pg')
170 elif options.profile == 'pprof':
171 libs.append('-lprofiler')
173 def shell_escape(str):
174 """Escape str such that it's interpreted as a single argument by
177 # This isn't complete, but it's just enough to make NINJA_PYTHON work.
178 if platform in ('windows', 'mingw'):
181 return "'%s'" % str.replace("'", "\\'")
184 if 'CFLAGS' in configure_env:
185 cflags.append(configure_env['CFLAGS'])
186 n.variable('cflags', ' '.join(shell_escape(flag) for flag in cflags))
187 if 'LDFLAGS' in configure_env:
188 ldflags.append(configure_env['LDFLAGS'])
189 n.variable('ldflags', ' '.join(shell_escape(flag) for flag in ldflags))
192 if platform == 'windows':
194 if options.with_ninja:
195 compiler = ('%s -t msvc -o $out -- $cxx /showIncludes' %
198 command='%s $cflags -c $in /Fo$out' % compiler,
200 description='CXX $out')
203 command='$cxx -MMD -MT $out -MF $out.d $cflags -c $in -o $out',
205 description='CXX $out')
208 if host == 'windows':
210 command='lib /nologo /ltcg /out:$out $in',
211 description='LIB $out')
212 elif host == 'mingw':
214 command='cmd /c $ar cqs $out.tmp $in && move /Y $out.tmp $out',
215 description='AR $out')
218 command='rm -f $out && $ar crs $out $in',
219 description='AR $out')
222 if platform == 'windows':
224 command='$cxx $in $libs /nologo /link $ldflags /out:$out',
225 description='LINK $out')
228 command='$cxx $ldflags -o $out $in $libs',
229 description='LINK $out')
234 if platform not in ('solaris', 'mingw', 'windows'):
235 n.comment('browse_py.h is used to inline browse.py.')
237 command='src/inline.sh $varname < $in > $out',
238 description='INLINE $out')
239 n.build(built('browse_py.h'), 'inline', src('browse.py'),
240 implicit='src/inline.sh',
241 variables=[('varname', 'kBrowsePy')])
244 objs += cxx('browse', order_only=built('browse_py.h'))
247 n.comment('the depfile parser and ninja lexers are generated using re2c.')
251 proc = subprocess.Popen(['re2c', '-V'], stdout=subprocess.PIPE)
252 return int(proc.communicate()[0], 10) >= 1103
257 command='re2c -b -i --no-generation-date -o $out $in',
258 description='RE2C $out')
259 # Generate the .cc files in the source directory so we can check them in.
260 n.build(src('depfile_parser.cc'), 're2c', src('depfile_parser.in.cc'))
261 n.build(src('lexer.cc'), 're2c', src('lexer.in.cc'))
263 print("warning: A compatible version of re2c (>= 0.11.3) was not found; "
264 "changes to src/*.in.cc will not affect your build.")
267 n.comment('Core source files all build into ninja library.')
268 for name in ['build',
286 if platform in ('mingw', 'windows'):
287 for name in ['subprocess-win32',
288 'includes_normalize-win32',
290 'msvc_helper_main-win32']:
292 if platform == 'windows':
293 objs += cxx('minidump-win32')
296 objs += cxx('subprocess-posix')
297 if platform == 'windows':
298 ninja_lib = n.build(built('ninja.lib'), 'ar', objs)
300 ninja_lib = n.build(built('libninja.a'), 'ar', objs)
303 if platform == 'windows':
304 libs.append('ninja.lib')
306 libs.append('-lninja')
310 n.comment('Main executable is library plus main() function.')
312 ninja = n.build(binary('ninja'), 'link', objs, implicit=ninja_lib,
313 variables=[('libs', libs)])
317 n.comment('Tests all build into ninja_test executable.')
320 test_cflags = cflags + ['-DGTEST_HAS_RTTI=0']
324 if options.with_gtest:
325 path = options.with_gtest
327 gtest_all_incs = '-I%s -I%s' % (path, os.path.join(path, 'include'))
328 if platform == 'windows':
329 gtest_cflags = '/nologo /EHsc /Zi ' + gtest_all_incs
331 gtest_cflags = '-fvisibility=hidden ' + gtest_all_incs
332 objs += n.build(built('gtest-all' + objext), 'cxx',
333 os.path.join(path, 'src', 'gtest-all.cc'),
334 variables=[('cflags', gtest_cflags)])
336 test_cflags.append('-I%s' % os.path.join(path, 'include'))
338 # Use gtest from system.
339 if platform == 'windows':
340 test_libs.extend(['gtest_main.lib', 'gtest.lib'])
342 test_libs.extend(['-lgtest_main', '-lgtest'])
344 n.variable('test_cflags', test_cflags)
345 for name in ['build_log_test',
348 'depfile_parser_test',
349 'disk_interface_test',
350 'edit_distance_test',
353 'manifest_parser_test',
359 objs += cxx(name, variables=[('cflags', '$test_cflags')])
360 if platform in ('windows', 'mingw'):
361 for name in ['includes_normalize_test', 'msvc_helper_test']:
362 objs += cxx(name, variables=[('cflags', test_cflags)])
364 if platform != 'mingw' and platform != 'windows':
365 test_libs.append('-lpthread')
366 ninja_test = n.build(binary('ninja_test'), 'link', objs, implicit=ninja_lib,
367 variables=[('ldflags', test_ldflags),
368 ('libs', test_libs)])
370 all_targets += ninja_test
373 n.comment('Ancillary executables.')
374 objs = cxx('parser_perftest')
375 all_targets += n.build(binary('parser_perftest'), 'link', objs,
376 implicit=ninja_lib, variables=[('libs', libs)])
377 objs = cxx('build_log_perftest')
378 all_targets += n.build(binary('build_log_perftest'), 'link', objs,
379 implicit=ninja_lib, variables=[('libs', libs)])
380 objs = cxx('canon_perftest')
381 all_targets += n.build(binary('canon_perftest'), 'link', objs,
382 implicit=ninja_lib, variables=[('libs', libs)])
383 objs = cxx('hash_collision_bench')
384 all_targets += n.build(binary('hash_collision_bench'), 'link', objs,
385 implicit=ninja_lib, variables=[('libs', libs)])
388 n.comment('Generate a graph using the "graph" tool.')
390 command='./ninja -t graph all > $out')
392 command='dot -Tpng $in > $out')
393 dot = n.build(built('graph.dot'), 'gendot', ['ninja', 'build.ninja'])
394 n.build('graph.png', 'gengraph', dot)
397 n.comment('Generate the manual using asciidoc.')
399 command='asciidoc -b docbook -d book -o $out $in',
400 description='ASCIIDOC $out')
402 command='xsltproc --nonet doc/docbook.xsl $in > $out',
403 description='XSLTPROC $out')
404 xml = n.build(built('manual.xml'), 'asciidoc', doc('manual.asciidoc'))
405 manual = n.build(doc('manual.html'), 'xsltproc', xml,
406 implicit=doc('style.css'))
407 n.build('manual', 'phony',
411 n.comment('Generate Doxygen.')
413 command='doxygen $in',
414 description='DOXYGEN $in')
415 n.variable('doxygen_mainpage_generator',
416 src('gen_doxygen_mainpage.sh'))
417 n.rule('doxygen_mainpage',
418 command='$doxygen_mainpage_generator $in > $out',
419 description='DOXYGEN_MAINPAGE $out')
420 mainpage = n.build(built('doxygen_mainpage'), 'doxygen_mainpage',
421 ['README', 'COPYING'],
422 implicit=['$doxygen_mainpage_generator'])
423 n.build('doxygen', 'doxygen', doc('doxygen.config'),
428 n.comment('Regenerate build files if build script changes.')
430 command='${configure_env}%s configure.py $configure_args' %
433 n.build('build.ninja', 'configure',
434 implicit=['configure.py', os.path.normpath('misc/ninja_syntax.py')])
441 n.comment('Packaging')
443 command="misc/packaging/rpmbuild.sh",
444 description='Building rpms..')
445 n.build('rpm', 'rpmbuild')
448 n.build('all', 'phony', all_targets)
450 print('wrote %s.' % BUILD_FILENAME)