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 Dave Robillard
5 # Copyright (C) 2008 Nedko Arnaudov
13 from TaskGen import feature, before, after
18 # Only run autowaf hooks once (even if sub projects call several times)
22 # Compute dependencies globally
24 #preproc.go_absolute = True
27 @after('apply_lib_vars')
28 @before('apply_obj_vars_cc', 'apply_obj_vars_cxx')
29 def include_config_h(self):
30 self.env.append_value('INC_PATHS', self.bld.srcnode)
33 "Add standard autowaf options if they havn't been added yet"
37 opt.tool_options('compiler_cc')
38 opt.tool_options('compiler_cxx')
39 opt.add_option('--debug', action='store_true', default=False, dest='debug',
40 help="Build debuggable binaries [Default: False]")
41 opt.add_option('--strict', action='store_true', default=False, dest='strict',
42 help="Use strict compiler flags and show all warnings [Default: False]")
43 opt.add_option('--build-docs', action='store_true', default=False, dest='build_docs',
44 help="Build documentation - requires doxygen [Default: False]")
45 opt.add_option('--bundle', action='store_true', default=False,
46 help="Build a self-contained bundle [Default: False]")
47 opt.add_option('--bindir', type='string',
48 help="Executable programs [Default: PREFIX/bin]")
49 opt.add_option('--libdir', type='string',
50 help="Libraries [Default: PREFIX/lib]")
51 opt.add_option('--includedir', type='string',
52 help="Header files [Default: PREFIX/include]")
53 opt.add_option('--datadir', type='string',
54 help="Shared data [Default: PREFIX/share]")
55 opt.add_option('--configdir', type='string',
56 help="Configuration data [Default: PREFIX/etc]")
57 opt.add_option('--mandir', type='string',
58 help="Manual pages [Default: DATADIR/man]")
59 opt.add_option('--htmldir', type='string',
60 help="HTML documentation [Default: DATADIR/doc/PACKAGE]")
61 opt.add_option('--lv2-user', action='store_true', default=False, dest='lv2_user',
62 help="Install LV2 bundles to user-local location [Default: False]")
63 if sys.platform == "darwin":
64 opt.add_option('--lv2dir', type='string',
65 help="LV2 bundles [Default: /Library/Audio/Plug-Ins/LV2]")
67 opt.add_option('--lv2dir', type='string',
68 help="LV2 bundles [Default: LIBDIR/lv2]")
71 def check_header(conf, name, define='', mandatory=False):
72 "Check for a header iff it hasn't been checked for yet"
73 if type(conf.env['AUTOWAF_HEADERS']) != dict:
74 conf.env['AUTOWAF_HEADERS'] = {}
76 checked = conf.env['AUTOWAF_HEADERS']
77 if not name in checked:
80 conf.check(header_name=name, define_name=define, mandatory=mandatory)
82 conf.check(header_name=name, mandatory=mandatory)
84 def check_tool(conf, name):
85 "Check for a tool iff it hasn't been checked for yet"
86 if type(conf.env['AUTOWAF_TOOLS']) != dict:
87 conf.env['AUTOWAF_TOOLS'] = {}
89 checked = conf.env['AUTOWAF_TOOLS']
90 if not name in checked:
95 return name.replace('/', '_').replace('++', 'PP').replace('-', '_')
97 def check_pkg(conf, name, **args):
98 if not 'mandatory' in args:
99 args['mandatory'] = True
100 "Check for a package iff it hasn't been checked for yet"
101 var_name = 'HAVE_' + nameify(args['uselib_store'])
102 check = not var_name in conf.env
103 if not check and 'atleast_version' in args:
104 # Re-check if version is newer than previous check
105 checked_version = conf.env['VERSION_' + name]
106 if checked_version and checked_version < args['atleast_version']:
109 conf.check_cfg(package=name, args="--cflags --libs", **args)
110 found = bool(conf.env[var_name])
112 conf.define(var_name, int(found))
113 if 'atleast_version' in args:
114 conf.env['VERSION_' + name] = args['atleast_version']
116 conf.undefine(var_name)
117 if args['mandatory'] == True:
118 conf.fatal("Required package " + name + " not found")
120 def chop_prefix(conf, var):
121 name = conf.env[var][len(conf.env['PREFIX']):]
122 if len(name) > 0 and name[0] == '/':
132 def append_cxx_flags(val):
133 conf.env.append_value('CCFLAGS', val)
134 conf.env.append_value('CXXFLAGS', val)
136 check_tool(conf, 'misc')
137 check_tool(conf, 'compiler_cc')
138 check_tool(conf, 'compiler_cxx')
139 conf.env['BUILD_DOCS'] = Options.options.build_docs
140 conf.env['DEBUG'] = Options.options.debug
141 conf.env['PREFIX'] = os.path.abspath(os.path.expanduser(os.path.normpath(conf.env['PREFIX'])))
142 if Options.options.bundle:
143 conf.env['BUNDLE'] = True
144 conf.define('BUNDLE', 1)
145 conf.env['BINDIR'] = conf.env['PREFIX']
146 conf.env['INCLUDEDIR'] = conf.env['PREFIX'] + '/Headers/'
147 conf.env['LIBDIR'] = conf.env['PREFIX'] + '/Libraries/'
148 conf.env['DATADIR'] = conf.env['PREFIX'] + '/Resources/'
149 conf.env['HTMLDIR'] = conf.env['PREFIX'] + '/Resources/Documentation/'
150 conf.env['MANDIR'] = conf.env['PREFIX'] + '/Resources/Man/'
151 conf.env['LV2DIR'] = conf.env['PREFIX'] + '/PlugIns/'
153 conf.env['BUNDLE'] = False
154 if Options.options.bindir:
155 conf.env['BINDIR'] = Options.options.bindir
157 conf.env['BINDIR'] = conf.env['PREFIX'] + '/bin/'
158 if Options.options.includedir:
159 conf.env['INCLUDEDIR'] = Options.options.includedir
161 conf.env['INCLUDEDIR'] = conf.env['PREFIX'] + '/include/'
162 if Options.options.libdir:
163 conf.env['LIBDIR'] = Options.options.libdir
165 conf.env['LIBDIR'] = conf.env['PREFIX'] + '/lib/'
166 if Options.options.datadir:
167 conf.env['DATADIR'] = Options.options.datadir
169 conf.env['DATADIR'] = conf.env['PREFIX'] + '/share/'
170 if Options.options.configdir:
171 conf.env['CONFIGDIR'] = Options.options.configdir
173 conf.env['CONFIGDIR'] = conf.env['PREFIX'] + '/etc/'
174 if Options.options.htmldir:
175 conf.env['HTMLDIR'] = Options.options.htmldir
177 conf.env['HTMLDIR'] = conf.env['DATADIR'] + 'doc/' + Utils.g_module.APPNAME + '/'
178 if Options.options.mandir:
179 conf.env['MANDIR'] = Options.options.mandir
181 conf.env['MANDIR'] = conf.env['DATADIR'] + 'man/'
182 if Options.options.lv2dir:
183 conf.env['LV2DIR'] = Options.options.lv2dir
185 if Options.options.lv2_user:
186 if sys.platform == "darwin":
187 conf.env['LV2DIR'] = os.getenv('HOME') + '/Library/Audio/Plug-Ins/LV2'
189 conf.env['LV2DIR'] = os.getenv('HOME') + '/.lv2'
191 if sys.platform == "darwin":
192 conf.env['LV2DIR'] = '/Library/Audio/Plug-Ins/LV2'
194 conf.env['LV2DIR'] = conf.env['LIBDIR'] + 'lv2/'
196 conf.env['BINDIRNAME'] = chop_prefix(conf, 'BINDIR')
197 conf.env['LIBDIRNAME'] = chop_prefix(conf, 'LIBDIR')
198 conf.env['DATADIRNAME'] = chop_prefix(conf, 'DATADIR')
199 conf.env['CONFIGDIRNAME'] = chop_prefix(conf, 'CONFIGDIR')
200 conf.env['LV2DIRNAME'] = chop_prefix(conf, 'LV2DIR')
202 if Options.options.debug:
203 conf.env['CCFLAGS'] = '-O0 -g'
204 conf.env['CXXFLAGS'] = '-O0 -g'
206 append_cxx_flags('-DNDEBUG')
207 if Options.options.strict:
208 conf.env.append_value('CCFLAGS', '-std=c99 -pedantic')
209 conf.env.append_value('CXXFLAGS', '-ansi -Woverloaded-virtual')
210 append_cxx_flags('-Wall -Wextra -Wno-unused-parameter')
211 append_cxx_flags('-fPIC -DPIC')
214 def set_local_lib(conf, name, has_objects):
215 conf.define('HAVE_' + nameify(name.upper()), 1)
217 if type(conf.env['AUTOWAF_LOCAL_LIBS']) != dict:
218 conf.env['AUTOWAF_LOCAL_LIBS'] = {}
219 conf.env['AUTOWAF_LOCAL_LIBS'][name.lower()] = True
221 if type(conf.env['AUTOWAF_LOCAL_HEADERS']) != dict:
222 conf.env['AUTOWAF_LOCAL_HEADERS'] = {}
223 conf.env['AUTOWAF_LOCAL_HEADERS'][name.lower()] = True
225 def use_lib(bld, obj, libs):
226 abssrcdir = os.path.abspath('.')
227 libs_list = libs.split()
229 in_headers = l.lower() in bld.env['AUTOWAF_LOCAL_HEADERS']
230 in_libs = l.lower() in bld.env['AUTOWAF_LOCAL_LIBS']
232 if hasattr(obj, 'uselib_local'):
233 obj.uselib_local += ' lib' + l.lower() + ' '
235 obj.uselib_local = 'lib' + l.lower() + ' '
237 if in_headers or in_libs:
238 inc_flag = '-iquote ' + abssrcdir + '/' + l.lower()
239 for f in ['CCFLAGS', 'CXXFLAGS']:
240 if not inc_flag in bld.env[f]:
241 bld.env.prepend_value(f, inc_flag)
243 if hasattr(obj, 'uselib'):
244 obj.uselib += ' ' + l
249 def display_header(title):
250 Utils.pprint('BOLD', title)
252 def display_msg(conf, msg, status = None, color = None):
254 if type(status) == bool and status or status == "True":
256 elif type(status) == bool and not status or status == "False":
258 Utils.pprint('NORMAL', "%s :" % msg.ljust(conf.line_just), sep='')
259 Utils.pprint(color, status)
261 def print_summary(conf):
268 display_header('Global configuration')
269 display_msg(conf, "Install prefix", conf.env['PREFIX'])
270 display_msg(conf, "Debuggable build", str(conf.env['DEBUG']))
271 display_msg(conf, "Build documentation", str(conf.env['BUILD_DOCS']))
275 def link_flags(env, lib):
276 return ' '.join(map(lambda x: env['LIB_ST'] % x, env['LIB_' + lib]))
278 def compile_flags(env, lib):
279 return ' '.join(map(lambda x: env['CPPPATH_ST'] % x, env['CPPPATH_' + lib]))
290 def build_pc(bld, name, version, libs):
291 '''Build a pkg-config file for a library.
292 name -- uppercase variable name (e.g. 'SOMENAME')
293 version -- version string (e.g. '1.2.3')
294 libs -- string/list of dependencies (e.g. 'LIBFOO GLIB')
297 obj = bld.new_task_gen('subst')
298 obj.source = name.lower() + '.pc.in'
299 obj.target = name.lower() + '.pc'
300 obj.install_path = '${PREFIX}/${LIBDIRNAME}/pkgconfig'
301 pkg_prefix = bld.env['PREFIX']
302 if pkg_prefix[-1] == '/':
303 pkg_prefix = pkg_prefix[:-1]
305 'prefix' : pkg_prefix,
306 'exec_prefix' : '${prefix}',
307 'libdir' : '${exec_prefix}/lib',
308 'includedir' : '${prefix}/include',
309 name + '_VERSION' : version,
311 if type(libs) != list:
314 obj.dict[i + '_LIBS'] = link_flags(bld.env, i)
315 obj.dict[i + '_CFLAGS'] = compile_flags(bld.env, i)
317 # Doxygen API documentation
318 def build_dox(bld, name, version, srcdir, blddir):
319 if not bld.env['BUILD_DOCS']:
321 obj = bld.new_task_gen('subst')
322 obj.source = 'doc/reference.doxygen.in'
323 obj.target = 'doc/reference.doxygen'
325 src_dir = srcdir + '/' + name.lower()
326 doc_dir = blddir + '/default/' + name.lower() + '/doc'
329 doc_dir = blddir + '/default/doc'
331 name + '_VERSION' : version,
332 name + '_SRCDIR' : os.path.abspath(src_dir),
333 name + '_DOC_DIR' : os.path.abspath(doc_dir)
335 obj.install_path = ''
336 out1 = bld.new_task_gen('command-output')
337 out1.stdout = '/doc/doxygen.out'
338 out1.stdin = '/doc/reference.doxygen' # whatever..
339 out1.command = 'doxygen'
340 out1.argv = [os.path.abspath(doc_dir) + '/reference.doxygen']
341 out1.command_is_external = True
343 # Version code file generation
344 def build_version_files(header_path, source_path, domain, major, minor, micro):
345 header_path = os.path.abspath(header_path)
346 source_path = os.path.abspath(source_path)
347 text = "int " + domain + "_major_version = " + str(major) + ";\n"
348 text += "int " + domain + "_minor_version = " + str(minor) + ";\n"
349 text += "int " + domain + "_micro_version = " + str(micro) + ";\n"
351 o = file(source_path, 'w')
355 print "Could not open", source_path, " for writing\n"
358 text = "#ifndef __" + domain + "_version_h__\n"
359 text += "#define __" + domain + "_version_h__\n"
360 text += "extern const char* " + domain + "_revision;\n"
361 text += "extern int " + domain + "_major_version;\n"
362 text += "extern int " + domain + "_minor_version;\n"
363 text += "extern int " + domain + "_micro_version;\n"
364 text += "#endif /* __" + domain + "_version_h__ */\n"
366 o = file(header_path, 'w')
370 print "Could not open", header_path, " for writing\n"
376 # This isn't really correct (for packaging), but people asking is annoying
377 if Options.commands['install']:
378 try: os.popen("/sbin/ldconfig")