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 "Check for a package iff it hasn't been checked for yet"
99 var_name = 'HAVE_' + nameify(args['uselib_store'])
100 check = not var_name in conf.env
101 if not check and 'atleast_version' in args:
102 # Re-check if version is newer than previous check
103 checked_version = conf.env['VERSION_' + name]
104 if checked_version and checked_version < args['atleast_version']:
107 conf.check_cfg(package=name, args="--cflags --libs", **args)
108 found = bool(conf.env[var_name])
110 conf.define(var_name, int(found))
111 if 'atleast_version' in args:
112 conf.env['VERSION_' + name] = args['atleast_version']
114 conf.undefine(var_name)
115 if args['mandatory'] == True:
116 conf.fatal("Required package " + name + " not found")
118 def chop_prefix(conf, var):
119 name = conf.env[var][len(conf.env['PREFIX']):]
120 if len(name) > 0 and name[0] == '/':
130 def append_cxx_flags(val):
131 conf.env.append_value('CCFLAGS', val)
132 conf.env.append_value('CXXFLAGS', val)
134 check_tool(conf, 'misc')
135 check_tool(conf, 'compiler_cc')
136 check_tool(conf, 'compiler_cxx')
137 conf.env['BUILD_DOCS'] = Options.options.build_docs
138 conf.env['DEBUG'] = Options.options.debug
139 conf.env['PREFIX'] = os.path.abspath(os.path.expanduser(os.path.normpath(conf.env['PREFIX'])))
140 if Options.options.bundle:
141 conf.env['BUNDLE'] = True
142 conf.define('BUNDLE', 1)
143 conf.env['BINDIR'] = conf.env['PREFIX']
144 conf.env['INCLUDEDIR'] = conf.env['PREFIX'] + '/Headers/'
145 conf.env['LIBDIR'] = conf.env['PREFIX'] + '/Libraries/'
146 conf.env['DATADIR'] = conf.env['PREFIX'] + '/Resources/'
147 conf.env['HTMLDIR'] = conf.env['PREFIX'] + '/Resources/Documentation/'
148 conf.env['MANDIR'] = conf.env['PREFIX'] + '/Resources/Man/'
149 conf.env['LV2DIR'] = conf.env['PREFIX'] + '/PlugIns/'
151 conf.env['BUNDLE'] = False
152 if Options.options.bindir:
153 conf.env['BINDIR'] = Options.options.bindir
155 conf.env['BINDIR'] = conf.env['PREFIX'] + '/bin/'
156 if Options.options.includedir:
157 conf.env['INCLUDEDIR'] = Options.options.includedir
159 conf.env['INCLUDEDIR'] = conf.env['PREFIX'] + '/include/'
160 if Options.options.libdir:
161 conf.env['LIBDIR'] = Options.options.libdir
163 conf.env['LIBDIR'] = conf.env['PREFIX'] + '/lib/'
164 if Options.options.datadir:
165 conf.env['DATADIR'] = Options.options.datadir
167 conf.env['DATADIR'] = conf.env['PREFIX'] + '/share/'
168 if Options.options.configdir:
169 conf.env['CONFIGDIR'] = Options.options.configdir
171 conf.env['CONFIGDIR'] = conf.env['PREFIX'] + '/etc/'
172 if Options.options.htmldir:
173 conf.env['HTMLDIR'] = Options.options.htmldir
175 conf.env['HTMLDIR'] = conf.env['DATADIR'] + 'doc/' + Utils.g_module.APPNAME + '/'
176 if Options.options.mandir:
177 conf.env['MANDIR'] = Options.options.mandir
179 conf.env['MANDIR'] = conf.env['DATADIR'] + 'man/'
180 if Options.options.lv2dir:
181 conf.env['LV2DIR'] = Options.options.lv2dir
183 if Options.options.lv2_user:
184 if sys.platform == "darwin":
185 conf.env['LV2DIR'] = os.getenv('HOME') + '/Library/Audio/Plug-Ins/LV2'
187 conf.env['LV2DIR'] = os.getenv('HOME') + '/.lv2'
189 if sys.platform == "darwin":
190 conf.env['LV2DIR'] = '/Library/Audio/Plug-Ins/LV2'
192 conf.env['LV2DIR'] = conf.env['LIBDIR'] + 'lv2/'
194 conf.env['BINDIRNAME'] = chop_prefix(conf, 'BINDIR')
195 conf.env['LIBDIRNAME'] = chop_prefix(conf, 'LIBDIR')
196 conf.env['DATADIRNAME'] = chop_prefix(conf, 'DATADIR')
197 conf.env['CONFIGDIRNAME'] = chop_prefix(conf, 'CONFIGDIR')
198 conf.env['LV2DIRNAME'] = chop_prefix(conf, 'LV2DIR')
200 if Options.options.debug:
201 conf.env['CCFLAGS'] = '-O0 -g -std=c99'
202 conf.env['CXXFLAGS'] = '-O0 -g -ansi'
203 if Options.options.strict:
204 conf.env['CCFLAGS'] = '-O0 -g -std=c99 -pedantic'
205 append_cxx_flags('-Wall -Wextra -Wno-unused-parameter')
206 conf.env.append_value('CXXFLAGS', '-Woverloaded-virtual')
207 append_cxx_flags('-fPIC -DPIC')
210 def set_local_lib(conf, name, has_objects):
211 conf.define('HAVE_' + nameify(name.upper()), 1)
213 if type(conf.env['AUTOWAF_LOCAL_LIBS']) != dict:
214 conf.env['AUTOWAF_LOCAL_LIBS'] = {}
215 conf.env['AUTOWAF_LOCAL_LIBS'][name.lower()] = True
217 if type(conf.env['AUTOWAF_LOCAL_HEADERS']) != dict:
218 conf.env['AUTOWAF_LOCAL_HEADERS'] = {}
219 conf.env['AUTOWAF_LOCAL_HEADERS'][name.lower()] = True
221 def use_lib(bld, obj, libs):
222 abssrcdir = os.path.abspath('.')
223 libs_list = libs.split()
225 in_headers = l.lower() in bld.env['AUTOWAF_LOCAL_HEADERS']
226 in_libs = l.lower() in bld.env['AUTOWAF_LOCAL_LIBS']
228 if hasattr(obj, 'uselib_local'):
229 obj.uselib_local += ' lib' + l.lower() + ' '
231 obj.uselib_local = 'lib' + l.lower() + ' '
233 if in_headers or in_libs:
234 inc_flag = '-iquote ' + abssrcdir + '/' + l.lower()
235 for f in ['CCFLAGS', 'CXXFLAGS']:
236 if not inc_flag in bld.env[f]:
237 bld.env.prepend_value(f, inc_flag)
239 if hasattr(obj, 'uselib'):
240 obj.uselib += ' ' + l
245 def display_header(title):
246 Utils.pprint('BOLD', title)
248 def display_msg(conf, msg, status = None, color = None):
250 if type(status) == bool and status or status == "True":
252 elif type(status) == bool and not status or status == "False":
254 Utils.pprint('NORMAL', "%s :" % msg.ljust(conf.line_just), sep='')
255 Utils.pprint(color, status)
257 def print_summary(conf):
264 display_header('Global configuration')
265 display_msg(conf, "Install prefix", conf.env['PREFIX'])
266 display_msg(conf, "Debuggable build", str(conf.env['DEBUG']))
267 display_msg(conf, "Build documentation", str(conf.env['BUILD_DOCS']))
271 def link_flags(env, lib):
272 return ' '.join(map(lambda x: env['LIB_ST'] % x, env['LIB_' + lib]))
274 def compile_flags(env, lib):
275 return ' '.join(map(lambda x: env['CPPPATH_ST'] % x, env['CPPPATH_' + lib]))
286 def build_pc(bld, name, version, libs):
287 '''Build a pkg-config file for a library.
288 name -- uppercase variable name (e.g. 'SOMENAME')
289 version -- version string (e.g. '1.2.3')
290 libs -- string/list of dependencies (e.g. 'LIBFOO GLIB')
293 obj = bld.new_task_gen('subst')
294 obj.source = name.lower() + '.pc.in'
295 obj.target = name.lower() + '.pc'
296 obj.install_path = '${PREFIX}/${LIBDIRNAME}/pkgconfig'
297 pkg_prefix = bld.env['PREFIX']
298 if pkg_prefix[-1] == '/':
299 pkg_prefix = pkg_prefix[:-1]
301 'prefix' : pkg_prefix,
302 'exec_prefix' : '${prefix}',
303 'libdir' : '${exec_prefix}/lib',
304 'includedir' : '${prefix}/include',
305 name + '_VERSION' : version,
307 if type(libs) != list:
310 obj.dict[i + '_LIBS'] = link_flags(bld.env, i)
311 obj.dict[i + '_CFLAGS'] = compile_flags(bld.env, i)
313 # Doxygen API documentation
314 def build_dox(bld, name, version, srcdir, blddir):
315 if not bld.env['BUILD_DOCS']:
317 obj = bld.new_task_gen('subst')
318 obj.source = 'doc/reference.doxygen.in'
319 obj.target = 'doc/reference.doxygen'
321 src_dir = srcdir + '/' + name.lower()
322 doc_dir = blddir + '/default/' + name.lower() + '/doc'
325 doc_dir = blddir + '/default/doc'
327 name + '_VERSION' : version,
328 name + '_SRCDIR' : os.path.abspath(src_dir),
329 name + '_DOC_DIR' : os.path.abspath(doc_dir)
331 obj.install_path = ''
332 out1 = bld.new_task_gen('command-output')
333 out1.stdout = '/doc/doxygen.out'
334 out1.stdin = '/doc/reference.doxygen' # whatever..
335 out1.command = 'doxygen'
336 out1.argv = [os.path.abspath(doc_dir) + '/reference.doxygen']
337 out1.command_is_external = True
340 # This isn't really correct (for packaging), but people asking is annoying
341 if Options.commands['install']:
342 try: os.popen("/sbin/ldconfig")