author Chris Manchester <>
Wed, 17 Aug 2016 15:02:31 -0700
changeset 309984 aa9e6ab2f1456657f0cb661b5f5067b91ea9a8d3
parent 309103 9a9a569a4c4753d9b8b9e86d2d6c443ec5f3f861
child 316482 732ee01f038f84648c48661b8d7a08e630a011ab
permissions -rw-r--r--
Bug 1295784 - Use `when` instead of `condition` as an argument name in Python configure's pkg_check_modules for consistency. r=glandium MozReview-Commit-ID: 61XglTI0BII

# -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*-
# vim: set filetype=python:
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at

pkg_config = check_prog('PKG_CONFIG', ('pkg-config',), allow_missing=True)

@checking('for pkg-config version')
def pkg_config_version(pkg_config):
    return Version(check_cmd_output(pkg_config, '--version').rstrip())

# Locates the given module using pkg-config.
# - `var` determines the name of variables to set when the package is found.
#   <var>_CFLAGS and <var>_LIBS are set with corresponding values.
# - `package_desc` package name and version requirement string, list of
#   strings describing packages to locate, or depends function that will
#   resolve to such a string or list of strings.
# - `when` a depends function that will determine whether to perform
#   any checks (default is to always perform checks).
# - `allow_missing` If set, failure to fulfill the package description
#   will not result in an error or logged message, and any error message
#   will be returned to the caller.
#   Returns `True` when the package description is fulfilled.
def pkg_check_modules(var, package_desc, when=always,
    if isinstance(package_desc, (tuple, list)):
        package_desc = ' '.join(package_desc)
    package_desc = dependable(package_desc)

    @depends_when(pkg_config, pkg_config_version, when=when)
    def check_pkg_config(pkg_config, version):
        min_version = '0.9.0'
        if pkg_config is None:
            die("*** The pkg-config script could not be found. Make sure it is\n"
                "*** in your path, or set the PKG_CONFIG environment variable\n"
                "*** to the full path to pkg-config.")
        if version < min_version:
            die("*** Your version of pkg-config is too old. You need version %s or newer.",

    @depends_when(pkg_config, package_desc, when=when)
    @imports(_from='mozbuild.configure.util', _import='LineIO')
    def package(pkg_config, package_desc):
        # package_desc may start as a depends function, so we can't use
        # @checking here."checking for %s... " % package_desc)
        with log.queue_debug():
                subprocess.check_output([pkg_config, '--errors-to-stdout',
                                         '--print-errors', package_desc])
                return True
            except subprocess.CalledProcessError as e:
                log_writer = log.warning if allow_missing else log.error
                with LineIO(lambda l: log_writer(l)) as o:
                if not allow_missing:

    @depends_when(pkg_config, package_desc, when=package)
    @checking('%s_CFLAGS' % var, callback=lambda t: ' '.join(t))
    def pkg_cflags(pkg_config, package_desc):
        flags = check_cmd_output(pkg_config, '--cflags', package_desc)
        return tuple(flags.split())

    @depends_when(pkg_config, package_desc, when=package)
    @checking('%s_LIBS' % var, callback=lambda t: ' '.join(t))
    def pkg_libs(pkg_config, package_desc):
        libs = check_cmd_output(pkg_config, '--libs', package_desc)
        # Remove evil flags like -Wl,--export-dynamic
        return tuple(libs.replace('-Wl,--export-dynamic', '').split())

    set_config('%s_CFLAGS' % var, pkg_cflags)
    set_config('%s_LIBS' % var, pkg_libs)

    return package