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('--mandir', type='string',
56 help="Manual pages [Default: DATADIR/man]")
57 opt.add_option('--htmldir', type='string',
58 help="HTML documentation [Default: DATADIR/doc/PACKAGE]")
59 opt.add_option('--lv2-user', action='store_true', default=False, dest='lv2_user',
60 help="Install LV2 bundles to user-local location [Default: False]")
61 if sys.platform == "darwin":
62 opt.add_option('--lv2dir', type='string',
63 help="LV2 bundles [Default: /Library/Audio/Plug-Ins/LV2]")
65 opt.add_option('--lv2dir', type='string',
66 help="LV2 bundles [Default: LIBDIR/lv2]")
69 def check_header(conf, name, define='', mandatory=False):
70 "Check for a header iff it hasn't been checked for yet"
71 if type(conf.env['AUTOWAF_HEADERS']) != dict:
72 conf.env['AUTOWAF_HEADERS'] = {}
74 checked = conf.env['AUTOWAF_HEADERS']
75 if not name in checked:
78 conf.check(header_name=name, define_name=define, mandatory=mandatory)
80 conf.check(header_name=name, mandatory=mandatory)
82 def check_tool(conf, name):
83 "Check for a tool iff it hasn't been checked for yet"
84 if type(conf.env['AUTOWAF_TOOLS']) != dict:
85 conf.env['AUTOWAF_TOOLS'] = {}
87 checked = conf.env['AUTOWAF_TOOLS']
88 if not name in checked:
92 def check_pkg(conf, name, **args):
93 "Check for a package iff it hasn't been checked for yet"
94 var_name = 'HAVE_' + args['uselib_store']
95 check = not var_name in conf.env
96 if not check and 'atleast_version' in args:
97 # Re-check if version is newer than previous check
98 checked_version = conf.env['VERSION_' + name]
99 if checked_version and checked_version < args['atleast_version']:
102 conf.check_cfg(package=name, args="--cflags --libs", **args)
103 found = bool(conf.env['HAVE_' + args['uselib_store']])
105 conf.define('HAVE_' + args['uselib_store'], int(found))
106 if 'atleast_version' in args:
107 conf.env['VERSION_' + name] = args['atleast_version']
109 conf.undefine('HAVE_' + args['uselib_store'])
110 if args['mandatory'] == True:
111 conf.fatal("Required package " + name + " not found")
113 def chop_prefix(conf, var):
114 name = conf.env[var][len(conf.env['PREFIX']):]
115 if len(name) > 0 and name[0] == '/':
125 def append_cxx_flags(val):
126 conf.env.append_value('CCFLAGS', val)
127 conf.env.append_value('CXXFLAGS', val)
128 check_tool(conf, 'misc')
129 check_tool(conf, 'compiler_cc')
130 check_tool(conf, 'compiler_cxx')
131 conf.env['BUILD_DOCS'] = Options.options.build_docs
132 conf.env['DEBUG'] = Options.options.debug
133 conf.env['PREFIX'] = os.path.abspath(os.path.expanduser(os.path.normpath(conf.env['PREFIX'])))
134 if Options.options.bundle:
135 conf.env['BUNDLE'] = True
136 conf.define('BUNDLE', 1)
137 conf.env['BINDIR'] = conf.env['PREFIX']
138 conf.env['INCLUDEDIR'] = conf.env['PREFIX'] + '/Headers/'
139 conf.env['LIBDIR'] = conf.env['PREFIX'] + '/Libraries/'
140 conf.env['DATADIR'] = conf.env['PREFIX'] + '/Resources/'
141 conf.env['HTMLDIR'] = conf.env['PREFIX'] + '/Resources/Documentation/'
142 conf.env['MANDIR'] = conf.env['PREFIX'] + '/Resources/Man/'
143 conf.env['LV2DIR'] = conf.env['PREFIX'] + '/PlugIns/'
145 conf.env['BUNDLE'] = False
146 if Options.options.bindir:
147 conf.env['BINDIR'] = Options.options.bindir
149 conf.env['BINDIR'] = conf.env['PREFIX'] + '/bin/'
150 if Options.options.includedir:
151 conf.env['INCLUDEDIR'] = Options.options.includedir
153 conf.env['INCLUDEDIR'] = conf.env['PREFIX'] + '/include/'
154 if Options.options.libdir:
155 conf.env['LIBDIR'] = Options.options.libdir
157 conf.env['LIBDIR'] = conf.env['PREFIX'] + '/lib/'
158 if Options.options.datadir:
159 conf.env['DATADIR'] = Options.options.datadir
161 conf.env['DATADIR'] = conf.env['PREFIX'] + '/share/'
162 if Options.options.htmldir:
163 conf.env['HTMLDIR'] = Options.options.htmldir
165 conf.env['HTMLDIR'] = conf.env['DATADIR'] + 'doc/' + Utils.g_module.APPNAME + '/'
166 if Options.options.mandir:
167 conf.env['MANDIR'] = Options.options.mandir
169 conf.env['MANDIR'] = 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.getenv('HOME') + '/Library/Audio/Plug-Ins/LV2'
177 conf.env['LV2DIR'] = os.getenv('HOME') + '/.lv2'
179 if sys.platform == "darwin":
180 conf.env['LV2DIR'] = '/Library/Audio/Plug-Ins/LV2'
182 conf.env['LV2DIR'] = conf.env['LIBDIR'] + 'lv2/'
184 conf.env['BINDIRNAME'] = chop_prefix(conf, 'BINDIR')
185 conf.env['LIBDIRNAME'] = chop_prefix(conf, 'LIBDIR')
186 conf.env['DATADIRNAME'] = chop_prefix(conf, 'DATADIR')
187 conf.env['LV2DIRNAME'] = chop_prefix(conf, 'LV2DIR')
189 if Options.options.debug:
190 conf.env['CCFLAGS'] = '-O0 -g -std=c99'
191 conf.env['CXXFLAGS'] = '-O0 -g -ansi'
192 if Options.options.strict:
193 conf.env['CCFLAGS'] = '-O0 -g -std=c99 -pedantic'
194 append_cxx_flags('-Wall -Wextra -Wno-unused-parameter')
195 conf.env.append_value('CXXFLAGS', '-Woverloaded-virtual')
196 append_cxx_flags('-fPIC -DPIC')
199 def set_local_lib(conf, name, has_objects):
200 conf.define('HAVE_' + name.upper(), 1)
202 if type(conf.env['AUTOWAF_LOCAL_LIBS']) != dict:
203 conf.env['AUTOWAF_LOCAL_LIBS'] = {}
204 conf.env['AUTOWAF_LOCAL_LIBS'][name.lower()] = True
206 if type(conf.env['AUTOWAF_LOCAL_HEADERS']) != dict:
207 conf.env['AUTOWAF_LOCAL_HEADERS'] = {}
208 conf.env['AUTOWAF_LOCAL_HEADERS'][name.lower()] = True
210 def use_lib(bld, obj, libs):
211 abssrcdir = os.path.abspath('.')
212 libs_list = libs.split()
214 in_headers = l.lower() in bld.env['AUTOWAF_LOCAL_HEADERS']
215 in_libs = l.lower() in bld.env['AUTOWAF_LOCAL_LIBS']
217 if hasattr(obj, 'uselib_local'):
218 obj.uselib_local += ' lib' + l.lower() + ' '
220 obj.uselib_local = 'lib' + l.lower() + ' '
222 if in_headers or in_libs:
223 inc_flag = '-iquote ' + abssrcdir + '/' + l.lower()
224 for f in ['CCFLAGS', 'CXXFLAGS']:
225 if not inc_flag in bld.env[f]:
226 bld.env.prepend_value(f, inc_flag)
228 if hasattr(obj, 'uselib'):
229 obj.uselib += ' ' + l
234 def display_header(title):
235 Utils.pprint('BOLD', title)
237 def display_msg(conf, msg, status = None, color = None):
239 if type(status) == bool and status or status == "True":
241 elif type(status) == bool and not status or status == "False":
243 print "%s : " % msg.ljust(conf.line_just),
244 Utils.pprint(color, status)
246 def print_summary(conf):
253 display_header('Global configuration')
254 display_msg(conf, "Install prefix", conf.env['PREFIX'])
255 display_msg(conf, "Debuggable build", str(conf.env['DEBUG']))
256 display_msg(conf, "Build documentation", str(conf.env['BUILD_DOCS']))
260 def link_flags(env, lib):
261 return ' '.join(map(lambda x: env['LIB_ST'] % x, env['LIB_' + lib]))
263 def compile_flags(env, lib):
264 return ' '.join(map(lambda x: env['CPPPATH_ST'] % x, env['CPPPATH_' + lib]))
275 def build_pc(bld, name, version, libs):
276 '''Build a pkg-config file for a library.
277 name -- uppercase variable name (e.g. 'SOMENAME')
278 version -- version string (e.g. '1.2.3')
279 libs -- string/list of dependencies (e.g. 'LIBFOO GLIB')
282 obj = bld.new_task_gen('subst')
283 obj.source = name.lower() + '.pc.in'
284 obj.target = name.lower() + '.pc'
285 obj.install_path = '${PREFIX}/${LIBDIRNAME}/pkgconfig'
286 pkg_prefix = bld.env['PREFIX']
287 if pkg_prefix[-1] == '/':
288 pkg_prefix = pkg_prefix[:-1]
290 'prefix' : pkg_prefix,
291 'exec_prefix' : '${prefix}',
292 'libdir' : '${exec_prefix}/lib',
293 'includedir' : '${prefix}/include',
294 name + '_VERSION' : version,
296 if type(libs) != list:
299 obj.dict[i + '_LIBS'] = link_flags(bld.env, i)
300 obj.dict[i + '_CFLAGS'] = compile_flags(bld.env, i)
302 # Doxygen API documentation
303 def build_dox(bld, name, version, srcdir, blddir):
304 if not bld.env['BUILD_DOCS']:
306 obj = bld.new_task_gen('subst')
307 obj.source = 'doc/reference.doxygen.in'
308 obj.target = 'doc/reference.doxygen'
310 src_dir = srcdir + '/' + name.lower()
311 doc_dir = blddir + '/default/' + name.lower() + '/doc'
314 doc_dir = blddir + '/default/doc'
316 name + '_VERSION' : version,
317 name + '_SRCDIR' : os.path.abspath(src_dir),
318 name + '_DOC_DIR' : os.path.abspath(doc_dir)
320 obj.install_path = ''
321 out1 = bld.new_task_gen('command-output')
322 out1.stdout = '/doc/doxygen.out'
323 out1.stdin = '/doc/reference.doxygen' # whatever..
324 out1.command = 'doxygen'
325 out1.argv = [os.path.abspath(doc_dir) + '/reference.doxygen']
326 out1.command_is_external = True
329 # This isn't really correct (for packaging), but people asking is annoying
330 if Options.commands['install']:
331 try: os.popen("/sbin/ldconfig")