ardupilot/Tools/ardupilotwaf/cxx_checks.py

# Copyright (C) 2016  Intel Corporation. All rights reserved.
#
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This file is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program.  If not, see <http://www.gnu.org/licenses/>.
"""
WAF Tool that checks cxx parameters, creating the ap_config.h
header file.

This tool needs compiler_cxx to be loaded, make sure you
load them before this tool.

Example::
    def configure(cfg):
        cfg.load('cxx_checks')
"""

from waflib.Configure import conf

@conf
def ap_common_checks(cfg):
    cfg.check(
        compiler='cxx',
        fragment='''
        #include <cmath>

        int main() {
          return std::isfinite(1.0f);
        }''',
        define_name="HAVE_CMATH_ISFINITE",
        msg="Checking for HAVE_CMATH_ISFINITE",
        mandatory=False,
    )

    cfg.check(
        compiler='cxx',
        fragment='''
        #include <cmath>

        int main() {
          return std::isinf(1.0f);
        }''',
        define_name="HAVE_CMATH_ISINF",
        msg="Checking for HAVE_CMATH_ISINF",
        mandatory=False,
    )

    cfg.check(
        compiler='cxx',
        fragment='''
        #include <cmath>

        int main() {
          return std::isnan(1.0f);
        }''',
        define_name="HAVE_CMATH_ISNAN",
        msg="Checking for HAVE_CMATH_ISNAN",
        mandatory=False,
    )

    # NEED_CMATH_FUNCTION_STD_NAMESPACE checks are needed due to
    # new gcc versions being more restrictive.
    #
    # Here we check if we need to add 'using std::function' to
    # the function.
    #
    # Without these checks, in some cases, gcc points this as
    # overloads or function duplication in scope.

    cfg.check(
        compiler='cxx',
        fragment='''
        #include <math.h>
        #include <cmath>

        using std::isfinite;

        int main() {
          return isfinite((double)1);
        }''',
        define_name="NEED_CMATH_ISFINITE_STD_NAMESPACE",
        msg="Checking for NEED_CMATH_ISFINITE_STD_NAMESPACE",
        mandatory=False,
    )

    cfg.check(
        compiler='cxx',
        fragment='''
        #include <math.h>
        #include <cmath>

        using std::isinf;

        int main() {
          return isinf((double)1);
        }''',
        define_name="NEED_CMATH_ISINF_STD_NAMESPACE",
        msg="Checking for NEED_CMATH_ISINF_STD_NAMESPACE",
        mandatory=False,
    )

    cfg.check(
        compiler='cxx',
        fragment='''
        #include <math.h>
        #include <cmath>

        using std::isnan;

        int main() {
          return isnan((double)1);
        }''',
        define_name="NEED_CMATH_ISNAN_STD_NAMESPACE",
        msg="Checking for NEED_CMATH_ISNAN_STD_NAMESPACE",
        mandatory=False,
    )

    cfg.check(header_name='endian.h', mandatory=False)

    cfg.check(header_name='byteswap.h', mandatory=False)

    cfg.check(
        compiler='cxx',
        fragment='''
        #include <string.h>
        int main() {
        const char *s = "abc";
          return memrchr((const void *)s, 0, 3) != NULL;
        }''',
        define_name="HAVE_MEMRCHR",
        msg="Checking for HAVE_MEMRCHR",
        mandatory=False,
    )
    
@conf
def check_librt(cfg, env):
    if cfg.env.DEST_OS == 'darwin':
        return True

    ret = cfg.check(
        compiler='cxx',
        fragment='''
        #include <time.h>

        int main() {
            clock_gettime(CLOCK_REALTIME, NULL);
        }''',
        msg='Checking for need to link with librt',
        okmsg='not necessary',
        errmsg='necessary',
        mandatory=False,
    )

    if ret:
        return ret

    ret = cfg.check(compiler='cxx', lib='rt')
    if ret:
        env.LIB += cfg.env['LIB_RT']

    return ret

@conf
def check_package(cfg, env, libname):
    '''use pkg-config to look for an installed library that has a LIBNAME.pc file'''
    capsname = libname.upper()

    cfg.env.stash()

    if not cfg.check_cfg(package=libname, mandatory=False, global_define=True,
                         args=['--libs', '--cflags'], uselib_store=capsname):
        # Don't even try to link if check_cfg fails
        cfg.env.revert()
        return False

    if not cfg.check(compiler='cxx',
            fragment='''int main() { return 0; }''',
            msg='Checking link with %s' % libname,
            mandatory=False,
            lib=libname,
            use=capsname):
        cfg.env.revert()
        return False

    cfg.env.commit()

    # Add to global environment:
    # we always want to use the library for all targets
    env.LIB += cfg.env['LIB_%s' % capsname]
    env.INCLUDES += cfg.env['INCLUDES_%s' % capsname]
    env.CFLAGS += cfg.env['CFLAGS_%s' % capsname]
    env.LIBPATH += cfg.env['LIBPATH_%s' % capsname]

    return True

@conf
def check_lttng(cfg, env):
    if not cfg.options.enable_lttng:
        cfg.msg("Checking for 'lttng-ust':", 'disabled', color='YELLOW')
        return False
    if cfg.env.STATIC_LINKING:
        # lttng-ust depends on libdl which means it can't be used in a static build
        cfg.msg("Checking for 'lttng-ust':", 'disabled for static build', color='YELLOW')
        return False

    return check_package(cfg, env, 'lttng-ust')

@conf
def check_libiio(cfg, env):
    if cfg.env.STATIC_LINKING:
        # libiio depends on libdl which means it can't be used in a static build
        cfg.msg("Checking for 'libiio':", 'disabled for static build', color='YELLOW')
        return False
    if cfg.options.disable_libiio:
        cfg.msg("Checking for 'libiio':", 'disabled', color='YELLOW')
        return False

    return check_package(cfg, env, 'libiio')

@conf
def check_libdl(cfg, env):
    if cfg.env.STATIC_LINKING:
        # using loadable modules for a static build is not recommended
        cfg.msg("Checking for 'libdl':", 'disabled for static build', color='YELLOW')
        return False
    ret = cfg.check(compiler='cxx', lib='dl', mandatory=False, global_define=True, define_name='HAVE_LIBDL')
    if ret:
        env.LIB += cfg.env['LIB_DL']
    return ret

@conf
def check_SFML(cfg, env):
    if not cfg.options.enable_sfml:
        cfg.msg("Checking for SFML graphics:", 'disabled', color='YELLOW')
        return False
    libs = ['sfml-graphics', 'sfml-window','sfml-system']
    for lib in libs:
        if not cfg.check(compiler='cxx', lib=lib, mandatory=False,
                         global_define=True):
            cfg.fatal("Missing SFML libraries - please install libsfml-dev")
            return False
    
    # see if we need Graphics.hpp or Graphics.h
    if not cfg.check(compiler='cxx',
                     fragment='''#include <SFML/Graphics.hpp>\nint main() {}''', define_name="HAVE_SFML_GRAPHICS_HPP",
                     msg="Checking for Graphics.hpp", mandatory=False):
        if not cfg.check(compiler='cxx', fragment='''#include <SFML/Graphics.h>\nint main() {}''', define_name="HAVE_SFML_GRAPHICS_H",
                         msg="Checking for Graphics.h", mandatory=False):
            cfg.fatal("Missing SFML headers SFML/Graphics.hpp or SFML/Graphics.h")
            return False
    env.LIB += libs
    return True


@conf
def check_SFML_Audio(cfg, env):
    if not cfg.options.enable_sfml_audio:
        cfg.msg("Checking for SFML audio:", 'disabled', color='YELLOW')
        return False
    libs = ['sfml-audio']
    for lib in libs:
        if not cfg.check(compiler='cxx', lib=lib, mandatory=False,
                         global_define=True):
            cfg.fatal("Missing SFML libraries - please install libsfml-dev")
            return False

    # see if we need Audio.hpp or Audio.h
    if not cfg.check(compiler='cxx',
                     fragment='''#include <SFML/Audio.hpp>\nint main() {}''', define_name="HAVE_SFML_AUDIO_HPP",
                     msg="Checking for Audio.hpp", mandatory=False):
        if not cfg.check(compiler='cxx', fragment='''#include <SFML/Audio.h>\nint main() {}''', define_name="HAVE_SFML_AUDIO_H",
                         msg="Checking for Audio.h", mandatory=False):
            cfg.fatal("Missing SFML headers SFML/Audio.hpp or SFML/Audio.h")
            return False
    env.LIB += libs
    return True