2 # Waf utilities for easily building standard unixey packages/libraries
3 # Licensed under the GNU GPL v2 or later, see COPYING file for details.
4 # Copyright (C) 2008 David Robillard
5 # Copyright (C) 2008 Nedko Arnaudov
14 from TaskGen
import feature
, before
, after
19 # Only run autowaf hooks once (even if sub projects call several times)
23 # Compute dependencies globally
25 #preproc.go_absolute = True
28 @after('apply_lib_vars')
29 @before('apply_obj_vars_cc', 'apply_obj_vars_cxx')
30 def include_config_h(self
):
31 self
.env
.append_value('INC_PATHS', self
.bld
.srcnode
)
34 "Add standard autowaf options if they havn't been added yet"
38 opt
.tool_options('compiler_cc')
39 opt
.tool_options('compiler_cxx')
40 opt
.add_option('--debug', action
='store_true', default
=False, dest
='debug',
41 help="Build debuggable binaries [Default: False]")
42 opt
.add_option('--strict', action
='store_true', default
=False, dest
='strict',
43 help="Use strict compiler flags and show all warnings [Default: False]")
44 opt
.add_option('--docs', action
='store_true', default
=False, dest
='docs',
45 help="Build documentation - requires doxygen [Default: False]")
46 opt
.add_option('--bundle', action
='store_true', default
=False,
47 help="Build a self-contained bundle [Default: False]")
48 opt
.add_option('--bindir', type='string',
49 help="Executable programs [Default: PREFIX/bin]")
50 opt
.add_option('--libdir', type='string',
51 help="Libraries [Default: PREFIX/lib]")
52 opt
.add_option('--includedir', type='string',
53 help="Header files [Default: PREFIX/include]")
54 opt
.add_option('--datadir', type='string',
55 help="Shared data [Default: PREFIX/share]")
56 opt
.add_option('--configdir', type='string',
57 help="Configuration data [Default: PREFIX/etc]")
58 opt
.add_option('--mandir', type='string',
59 help="Manual pages [Default: DATADIR/man]")
60 opt
.add_option('--htmldir', type='string',
61 help="HTML documentation [Default: DATADIR/doc/PACKAGE]")
62 opt
.add_option('--lv2-user', action
='store_true', default
=False, dest
='lv2_user',
63 help="Install LV2 bundles to user-local location [Default: False]")
64 if sys
.platform
== "darwin":
65 opt
.add_option('--lv2dir', type='string',
66 help="LV2 bundles [Default: /Library/Audio/Plug-Ins/LV2]")
68 opt
.add_option('--lv2dir', type='string',
69 help="LV2 bundles [Default: LIBDIR/lv2]")
72 def check_header(conf
, name
, define
='', mandatory
=False):
73 "Check for a header iff it hasn't been checked for yet"
74 if type(conf
.env
['AUTOWAF_HEADERS']) != dict:
75 conf
.env
['AUTOWAF_HEADERS'] = {}
77 checked
= conf
.env
['AUTOWAF_HEADERS']
78 if not name
in checked
:
80 includes
= '' # search default system include paths
81 if sys
.platform
== "darwin":
82 includes
= '/opt/local/include'
84 conf
.check(header_name
=name
, includes
=includes
, define_name
=define
, mandatory
=mandatory
)
86 conf
.check(header_name
=name
, includes
=includes
, mandatory
=mandatory
)
89 return name
.replace('/', '_').replace('++', 'PP').replace('-', '_').replace('.', '_')
91 def check_pkg(conf
, name
, **args
):
92 if not 'mandatory' in args
:
93 args
['mandatory'] = True
94 "Check for a package iff it hasn't been checked for yet"
95 var_name
= 'HAVE_' + nameify(args
['uselib_store'])
96 check
= not var_name
in conf
.env
97 if not check
and 'atleast_version' in args
:
98 # Re-check if version is newer than previous check
99 checked_version
= conf
.env
['VERSION_' + name
]
100 if checked_version
and checked_version
< args
['atleast_version']:
103 conf
.check_cfg(package
=name
, args
="--cflags --libs", **args
)
104 found
= bool(conf
.env
[var_name
])
106 conf
.define(var_name
, int(found
))
107 if 'atleast_version' in args
:
108 conf
.env
['VERSION_' + name
] = args
['atleast_version']
110 conf
.undefine(var_name
)
111 if args
['mandatory'] == True:
112 conf
.fatal("Required package " + name
+ " not found")
118 def append_cxx_flags(vals
):
119 conf
.env
.append_value('CCFLAGS', vals
.split())
120 conf
.env
.append_value('CXXFLAGS', vals
.split())
122 display_header('Global Configuration')
123 conf
.check_tool('misc')
124 conf
.check_tool('compiler_cc')
125 conf
.check_tool('compiler_cxx')
126 conf
.env
['DOCS'] = Options
.options
.docs
127 conf
.env
['DEBUG'] = Options
.options
.debug
128 conf
.env
['STRICT'] = Options
.options
.strict
129 conf
.env
['PREFIX'] = os
.path
.abspath(os
.path
.expanduser(os
.path
.normpath(conf
.env
['PREFIX'])))
130 if Options
.options
.bundle
:
131 conf
.env
['BUNDLE'] = True
132 conf
.define('BUNDLE', 1)
133 conf
.env
['BINDIR'] = conf
.env
['PREFIX']
134 conf
.env
['INCLUDEDIR'] = os
.path
.join(conf
.env
['PREFIX'], 'Headers')
135 conf
.env
['LIBDIR'] = os
.path
.join(conf
.env
['PREFIX'], 'Libraries')
136 conf
.env
['DATADIR'] = os
.path
.join(conf
.env
['PREFIX'], 'Resources')
137 conf
.env
['HTMLDIR'] = os
.path
.join(conf
.env
['PREFIX'], 'Resources/Documentation')
138 conf
.env
['MANDIR'] = os
.path
.join(conf
.env
['PREFIX'], 'Resources/Man')
139 conf
.env
['LV2DIR'] = os
.path
.join(conf
.env
['PREFIX'], 'PlugIns')
141 conf
.env
['BUNDLE'] = False
142 if Options
.options
.bindir
:
143 conf
.env
['BINDIR'] = Options
.options
.bindir
145 conf
.env
['BINDIR'] = os
.path
.join(conf
.env
['PREFIX'], 'bin')
146 if Options
.options
.includedir
:
147 conf
.env
['INCLUDEDIR'] = Options
.options
.includedir
149 conf
.env
['INCLUDEDIR'] = os
.path
.join(conf
.env
['PREFIX'], 'include')
150 if Options
.options
.libdir
:
151 conf
.env
['LIBDIR'] = Options
.options
.libdir
153 conf
.env
['LIBDIR'] = os
.path
.join(conf
.env
['PREFIX'], 'lib')
154 if Options
.options
.datadir
:
155 conf
.env
['DATADIR'] = Options
.options
.datadir
157 conf
.env
['DATADIR'] = os
.path
.join(conf
.env
['PREFIX'], 'share')
158 if Options
.options
.configdir
:
159 conf
.env
['CONFIGDIR'] = Options
.options
.configdir
161 conf
.env
['CONFIGDIR'] = os
.path
.join(conf
.env
['PREFIX'], 'etc')
162 if Options
.options
.htmldir
:
163 conf
.env
['HTMLDIR'] = Options
.options
.htmldir
165 conf
.env
['HTMLDIR'] = os
.path
.join(conf
.env
['DATADIR'], 'doc', Utils
.g_module
.APPNAME
)
166 if Options
.options
.mandir
:
167 conf
.env
['MANDIR'] = Options
.options
.mandir
169 conf
.env
['MANDIR'] = os
.path
.join(conf
.env
['DATADIR'], 'man')
170 if Options
.options
.lv2dir
:
171 conf
.env
['LV2DIR'] = Options
.options
.lv2dir
173 if Options
.options
.lv2_user
:
174 if sys
.platform
== "darwin":
175 conf
.env
['LV2DIR'] = os
.path
.join(os
.getenv('HOME'), 'Library/Audio/Plug-Ins/LV2')
177 conf
.env
['LV2DIR'] = os
.path
.join(os
.getenv('HOME'), '.lv2')
179 if sys
.platform
== "darwin":
180 conf
.env
['LV2DIR'] = '/Library/Audio/Plug-Ins/LV2'
182 conf
.env
['LV2DIR'] = os
.path
.join(conf
.env
['LIBDIR'], 'lv2')
184 conf
.env
['BINDIRNAME'] = os
.path
.basename(conf
.env
['BINDIR'])
185 conf
.env
['LIBDIRNAME'] = os
.path
.basename(conf
.env
['LIBDIR'])
186 conf
.env
['DATADIRNAME'] = os
.path
.basename(conf
.env
['DATADIR'])
187 conf
.env
['CONFIGDIRNAME'] = os
.path
.basename(conf
.env
['CONFIGDIR'])
188 conf
.env
['LV2DIRNAME'] = os
.path
.basename(conf
.env
['LV2DIR'])
190 if Options
.options
.docs
:
191 doxygen
= conf
.find_program('doxygen')
193 conf
.fatal("Doxygen is required to build documentation, configure without --docs")
195 dot
= conf
.find_program('dot')
197 conf
.fatal("Graphviz (dot) is required to build documentation, configure without --docs")
199 if Options
.options
.debug
:
200 conf
.env
['CCFLAGS'] = [ '-O0', '-g' ]
201 conf
.env
['CXXFLAGS'] = [ '-O0', '-g' ]
203 append_cxx_flags('-DNDEBUG')
205 if Options
.options
.strict
:
206 conf
.env
.append_value('CCFLAGS', [ '-std=c99', '-pedantic' ])
207 conf
.env
.append_value('CXXFLAGS', [ '-ansi', '-Woverloaded-virtual', '-Wnon-virtual-dtor'])
208 append_cxx_flags('-Wall -Wextra -Wno-unused-parameter')
210 append_cxx_flags('-fPIC -DPIC -fshow-column')
212 display_msg(conf
, "Install prefix", conf
.env
['PREFIX'])
213 display_msg(conf
, "Debuggable build", str(conf
.env
['DEBUG']))
214 display_msg(conf
, "Strict compiler flags", str(conf
.env
['STRICT']))
215 display_msg(conf
, "Build documentation", str(conf
.env
['DOCS']))
220 def set_local_lib(conf
, name
, has_objects
):
221 conf
.define('HAVE_' + nameify(name
.upper()), 1)
223 if type(conf
.env
['AUTOWAF_LOCAL_LIBS']) != dict:
224 conf
.env
['AUTOWAF_LOCAL_LIBS'] = {}
225 conf
.env
['AUTOWAF_LOCAL_LIBS'][name
.lower()] = True
227 if type(conf
.env
['AUTOWAF_LOCAL_HEADERS']) != dict:
228 conf
.env
['AUTOWAF_LOCAL_HEADERS'] = {}
229 conf
.env
['AUTOWAF_LOCAL_HEADERS'][name
.lower()] = True
231 def use_lib(bld
, obj
, libs
):
232 abssrcdir
= os
.path
.abspath('.')
233 libs_list
= libs
.split()
235 in_headers
= l
.lower() in bld
.env
['AUTOWAF_LOCAL_HEADERS']
236 in_libs
= l
.lower() in bld
.env
['AUTOWAF_LOCAL_LIBS']
238 if hasattr(obj
, 'uselib_local'):
239 obj
.uselib_local
+= ' lib' + l
.lower() + ' '
241 obj
.uselib_local
= 'lib' + l
.lower() + ' '
243 if in_headers
or in_libs
:
244 inc_flag
= '-iquote ' + os
.path
.join(abssrcdir
, l
.lower())
245 for f
in ['CCFLAGS', 'CXXFLAGS']:
246 if not inc_flag
in bld
.env
[f
]:
247 bld
.env
.append_value(f
, inc_flag
)
249 if hasattr(obj
, 'uselib'):
250 obj
.uselib
+= ' ' + l
255 def display_header(title
):
256 Utils
.pprint('BOLD', title
)
258 def display_msg(conf
, msg
, status
= None, color
= None):
260 if type(status
) == bool and status
or status
== "True":
262 elif type(status
) == bool and not status
or status
== "False":
264 Utils
.pprint('BOLD', "%s :" % msg
.ljust(conf
.line_just
), sep
='')
265 Utils
.pprint(color
, status
)
267 def link_flags(env
, lib
):
268 return ' '.join(map(lambda x
: env
['LIB_ST'] % x
, env
['LIB_' + lib
]))
270 def compile_flags(env
, lib
):
271 return ' '.join(map(lambda x
: env
['CPPPATH_ST'] % x
, env
['CPPPATH_' + lib
]))
282 def build_pc(bld
, name
, version
, libs
):
283 '''Build a pkg-config file for a library.
284 name -- uppercase variable name (e.g. 'SOMENAME')
285 version -- version string (e.g. '1.2.3')
286 libs -- string/list of dependencies (e.g. 'LIBFOO GLIB')
289 obj
= bld
.new_task_gen('subst')
290 obj
.source
= name
.lower() + '.pc.in'
291 obj
.target
= name
.lower() + '.pc'
292 obj
.install_path
= '${PREFIX}/${LIBDIRNAME}/pkgconfig'
293 pkg_prefix
= bld
.env
['PREFIX']
294 if pkg_prefix
[-1] == '/':
295 pkg_prefix
= pkg_prefix
[:-1]
297 'prefix' : pkg_prefix
,
298 'exec_prefix' : '${prefix}',
299 'libdir' : '${prefix}/' + bld
.env
['LIBDIRNAME'],
300 'includedir' : '${prefix}/include',
301 name
+ '_VERSION' : version
,
303 if type(libs
) != list:
306 obj
.dict[i
+ '_LIBS'] = link_flags(bld
.env
, i
)
307 obj
.dict[i
+ '_CFLAGS'] = compile_flags(bld
.env
, i
)
309 # Doxygen API documentation
310 def build_dox(bld
, name
, version
, srcdir
, blddir
):
311 if not bld
.env
['DOCS']:
313 obj
= bld
.new_task_gen('subst')
314 obj
.source
= 'doc/reference.doxygen.in'
315 obj
.target
= 'doc/reference.doxygen'
317 src_dir
= os
.path
.join(srcdir
, name
.lower())
318 doc_dir
= os
.path
.join(blddir
, 'default', name
.lower(), 'doc')
321 doc_dir
= os
.path
.join(blddir
, 'default', 'doc')
323 name
+ '_VERSION' : version
,
324 name
+ '_SRCDIR' : os
.path
.abspath(src_dir
),
325 name
+ '_DOC_DIR' : os
.path
.abspath(doc_dir
)
327 obj
.install_path
= ''
328 out1
= bld
.new_task_gen('command-output')
329 out1
.dependencies
= [obj
]
330 out1
.stdout
= '/doc/doxygen.out'
331 out1
.stdin
= '/doc/reference.doxygen' # whatever..
332 out1
.command
= 'doxygen'
333 out1
.argv
= [os
.path
.abspath(doc_dir
) + '/reference.doxygen']
334 out1
.command_is_external
= True
336 # Version code file generation
337 def build_version_files(header_path
, source_path
, domain
, major
, minor
, micro
):
338 header_path
= os
.path
.abspath(header_path
)
339 source_path
= os
.path
.abspath(source_path
)
340 text
= "int " + domain
+ "_major_version = " + str(major
) + ";\n"
341 text
+= "int " + domain
+ "_minor_version = " + str(minor
) + ";\n"
342 text
+= "int " + domain
+ "_micro_version = " + str(micro
) + ";\n"
344 o
= file(source_path
, 'w')
348 print "Could not open", source_path
, " for writing\n"
351 text
= "#ifndef __" + domain
+ "_version_h__\n"
352 text
+= "#define __" + domain
+ "_version_h__\n"
353 text
+= "extern const char* " + domain
+ "_revision;\n"
354 text
+= "extern int " + domain
+ "_major_version;\n"
355 text
+= "extern int " + domain
+ "_minor_version;\n"
356 text
+= "extern int " + domain
+ "_micro_version;\n"
357 text
+= "#endif /* __" + domain
+ "_version_h__ */\n"
359 o
= file(header_path
, 'w')
363 print "Could not open", header_path
, " for writing\n"
368 def run_tests(ctx
, appname
, tests
):
369 orig_dir
= os
.path
.abspath(os
.curdir
)
373 top_level
= os
.path
.abspath(ctx
.curdir
) != os
.path
.abspath(os
.curdir
)
375 os
.chdir('./build/default/' + appname
)
378 os
.chdir('./build/default')
381 lcov_log
= open('lcov.log', 'w')
383 # Clear coverage data
384 subprocess
.call('lcov -d ./src -z'.split(),
385 stdout
=lcov_log
, stderr
=lcov_log
)
388 print "Failed to run lcov, no coverage report will be generated"
394 Utils
.pprint('BOLD', 'Running %s test %s' % (appname
, i
))
395 if subprocess
.call(i
) == 0:
396 Utils
.pprint('GREEN', 'Passed %s %s' % (appname
, i
))
399 Utils
.pprint('RED', 'Failed %s %s' % (appname
, i
))
402 # Generate coverage data
403 coverage_lcov
= open('coverage.lcov', 'w')
404 subprocess
.call(('lcov -c -d ./src -d ./test -b ' + base
).split(),
405 stdout
=coverage_lcov
, stderr
=lcov_log
)
406 coverage_lcov
.close()
408 # Strip out unwanted stuff
409 coverage_stripped_lcov
= open('coverage-stripped.lcov', 'w')
410 subprocess
.call('lcov --remove coverage.lcov *boost* c++*'.split(),
411 stdout
=coverage_stripped_lcov
, stderr
=lcov_log
)
412 coverage_stripped_lcov
.close()
414 # Generate HTML coverage output
415 if not os
.path
.isdir('./coverage'):
416 os
.makedirs('./coverage')
417 subprocess
.call('genhtml -o coverage coverage-stripped.lcov'.split(),
418 stdout
=lcov_log
, stderr
=lcov_log
)
423 Utils
.pprint('BOLD', 'Summary:', sep
=''),
425 Utils
.pprint('GREEN', 'All ' + appname
+ ' tests passed')
427 Utils
.pprint('RED', str(failures
) + ' ' + appname
+ ' test(s) failed')
429 Utils
.pprint('BOLD', 'Coverage:', sep
='')
430 print os
.path
.abspath('coverage/index.html')
435 # This isn't really correct (for packaging), but people asking is annoying
436 if Options
.commands
['install']:
437 try: os
.popen("/sbin/ldconfig")