Merge pull request #223 from carlosmn/valgrind

[libgit2.git] / wscript

from __future__ import with_statement
from waflib.Context import Context
from waflib.Build import BuildContext, CleanContext, \
        InstallContext, UninstallContext

# Unix flags
CFLAGS_UNIX = ["-O2", "-Wall", "-Wextra", "-fPIC"]
CFLAGS_UNIX_DBG = ['-g', '-O0']

# Windows MSVC flags
CFLAGS_WIN32_COMMON = ['/TC', '/W4', '/WX', '/nologo', '/Zi']
CFLAGS_WIN32_RELEASE = ['/O2', '/MD']

# Note: /RTC* cannot be used with optimization on.
CFLAGS_WIN32_DBG = ['/Od', '/RTC1', '/RTCc', '/DEBUG', '/MDd']
CFLAGS_WIN32_L = ['/RELEASE']  # used for /both/ debug and release builds.
                               # sets the module's checksum in the header.
CFLAGS_WIN32_L_DBG = ['/DEBUG']

ALL_LIBS = ['crypto', 'pthread', 'sqlite3', 'hiredis']

def options(opt):
    opt.load('compiler_c')
    opt.add_option('--sha1', action='store', default='builtin',
        help="Use the builtin SHA1 routines (builtin), the \
PPC optimized version (ppc) or the SHA1 functions from OpenSSL (openssl)")
    opt.add_option('--debug', action='store_true', default=False,
        help='Compile with debug symbols')
    opt.add_option('--msvc', action='store', default=None,
        help='Force a specific MSVC++ version (7.1, 8.0, 9.0, 10.0), if more than one is installed')
    opt.add_option('--arch', action='store', default='x86',
        help='Select target architecture (ia64, x64, x86, x86_amd64, x86_ia64)')
    opt.add_option('--with-sqlite', action='store_true', default=False,
        dest='use_sqlite', help='Enable sqlite support')
    opt.add_option('--with-hiredis', action='store_true', default=False,
        dest='use_hiredis', help='Enable redis support using hiredis')
    opt.add_option('--threadsafe', action='store_true', default=False,
        help='Make libgit2 thread-safe (requires pthreads)')

def configure(conf):

    # load the MSVC configuration flags
    if conf.options.msvc:
        conf.env['MSVC_VERSIONS'] = ['msvc ' + conf.options.msvc]

    conf.env['MSVC_TARGETS'] = [conf.options.arch]

    # default configuration for C programs
    conf.load('compiler_c')

    dbg = conf.options.debug

    conf.env.CFLAGS += CFLAGS_UNIX + (CFLAGS_UNIX_DBG if dbg else [])

    if conf.env.DEST_OS == 'win32':
        conf.env.PLATFORM = 'win32'

        if conf.env.CC_NAME == 'msvc':
            conf.env.CFLAGS = CFLAGS_WIN32_COMMON + \
              (CFLAGS_WIN32_DBG if dbg else CFLAGS_WIN32_RELEASE)
            conf.env.LINKFLAGS += CFLAGS_WIN32_L + \
              (CFLAGS_WIN32_L_DBG if dbg else [])
            conf.env.DEFINES += ['WIN32', '_DEBUG', '_LIB']

    else:
        conf.env.PLATFORM = 'unix'

    if conf.env.DEST_OS == 'sunos':
        conf.env.DEFINES += ['NO_VIZ']

    if conf.options.threadsafe:
        if conf.env.PLATFORM == 'unix':
            conf.check_cc(lib='pthread', uselib_store='pthread')
        conf.env.DEFINES += ['GIT_THREADS']

    # check for sqlite3
    if conf.options.use_sqlite and conf.check_cc(
        lib='sqlite3', uselib_store='sqlite3', install_path=None, mandatory=False):
        conf.env.DEFINES += ['GIT2_SQLITE_BACKEND']

    # check for hiredis
    if conf.options.use_hiredis and conf.check_cc(
        lib='hiredis', uselib_store='hiredis', install_path=None, mandatory=False):
        conf.env.DEFINES += ['GIT2_HIREDIS_BACKEND']


    if conf.options.sha1 not in ['openssl', 'ppc', 'builtin']:
        conf.fatal('Invalid SHA1 option')

    # check for libcrypto (openssl) if we are using its SHA1 functions
    if conf.options.sha1 == 'openssl':
        conf.check_cfg(package='libcrypto', args=['--cflags', '--libs'], uselib_store='crypto')
        conf.env.DEFINES += ['OPENSSL_SHA1']

    elif conf.options.sha1 == 'ppc':
        conf.env.DEFINES += ['PPC_SHA1']

    conf.env.sha1 = conf.options.sha1

def build(bld):

    # command '[build|clean|install|uninstall]-static'
    if bld.variant == 'static':
        build_library(bld, 'static')

    # command '[build|clean|install|uninstall]-shared'
    elif bld.variant == 'shared':
        build_library(bld, 'shared')

    # command '[build|clean]-tests'
    elif bld.variant == 'test':
        build_library(bld, 'objects')
        build_test(bld)

    # command 'build|clean|install|uninstall': by default, run
    # the same command for both the static and the shared lib
    else:
        from waflib import Options
        Options.commands = [bld.cmd + '-shared', bld.cmd + '-static'] + Options.commands

def get_libgit2_version(git2_h):
    import re
    line = None

    with open(git2_h) as f:
        line = re.search(r'^#define LIBGIT2_VERSION "(\d+\.\d+\.\d+)"$', f.read(), re.MULTILINE)

    if line is None:
        raise Exception("Failed to detect libgit2 version")

    return line.group(1)


def build_library(bld, build_type):

    BUILD = {
        'shared' : bld.shlib,
        'static' : bld.stlib,
        'objects' : bld.objects
    }

    directory = bld.path
    sources = directory.ant_glob('src/*.c')

    # Find the version of the library, from our header file
    version = get_libgit2_version(directory.find_node("include/git2.h").abspath())

    # Compile platform-dependant code
    # E.g.  src/unix/*.c
    #       src/win32/*.c
    sources = sources + directory.ant_glob('src/%s/*.c' % bld.env.PLATFORM)
    sources = sources + directory.ant_glob('src/backends/*.c')
    sources = sources + directory.ant_glob('deps/zlib/*.c')

    # SHA1 methods source
    if bld.env.sha1 == "ppc":
        sources.append('src/ppc/sha1.c')
    else:
        sources.append('src/block-sha1/sha1.c')
    #------------------------------
    # Build the main library
    #------------------------------

    # either as static or shared;
    BUILD[build_type](
        source=sources,
        target='git2',
        includes=['src', 'include', 'deps/zlib'],
        install_path='${LIBDIR}',
        use=ALL_LIBS,
        vnum=version,
    )

    # On Unix systems, build the Pkg-config entry file
    if bld.env.PLATFORM == 'unix' and bld.is_install:
        bld(rule="""sed -e 's#@prefix@#${PREFIX}#' -e 's#@libdir@#${LIBDIR}#' -e 's#@version@#%s#' < ${SRC} > ${TGT}""" % version,
            source='libgit2.pc.in',
            target='libgit2.pc',
            install_path='${LIBDIR}/pkgconfig',
        )

    # Install headers
    bld.install_files('${PREFIX}/include', directory.find_node('include/git2.h'))
    bld.install_files('${PREFIX}/include/git2', directory.ant_glob('include/git2/*.h'))

    # On Unix systems, let them know about installation
    if bld.env.PLATFORM == 'unix' and bld.cmd == 'install-shared':
        bld.add_post_fun(call_ldconfig)

def call_ldconfig(bld):
    import distutils.spawn as s
    ldconf = s.find_executable('ldconfig')
    if ldconf:
        bld.exec_command(ldconf)

def build_test(bld):
    directory = bld.path
    resources_path = directory.find_node('tests/resources/').abspath().replace('\\', '/')

    sources = ['tests/test_lib.c', 'tests/test_helpers.c', 'tests/test_main.c']
    sources = sources + directory.ant_glob('tests/t??-*.c')

    bld.program(
        source=sources,
        target='libgit2_test',
        includes=['src', 'tests', 'include'],
        defines=['TEST_RESOURCES="%s"' % resources_path],
        use=['git2'] + ALL_LIBS
    )

class _test(BuildContext):
    cmd = 'test'
    fun = 'test'

def test(bld):
    from waflib import Options
    Options.commands = ['build-test', 'run-test'] + Options.commands

class _build_doc(Context):
    cmd = 'doxygen'
    fun = 'build_docs'

def build_docs(ctx):
    ctx.exec_command("doxygen api.doxygen")
    ctx.exec_command("git stash")
    ctx.exec_command("git checkout gh-pages")
    ctx.exec_command("cp -Rf apidocs/html/* .")
    ctx.exec_command("git add .")
    ctx.exec_command("git commit -am 'generated docs'")
    ctx.exec_command("git push origin gh-pages")
    ctx.exec_command("git checkout master")

class _run_test(Context):
    cmd = 'run-test'
    fun = 'run_test'

def run_test(ctx):
    import shutil, tempfile, sys

    failed = False

    test_path = 'build/test/libgit2_test'
    if sys.platform == 'win32':
        test_path += '.exe'

    test_folder = tempfile.mkdtemp()
    test = ctx.path.find_node(test_path)

    if not test or ctx.exec_command(test.abspath(), cwd=test_folder) != 0:
        failed = True

    shutil.rmtree(test_folder)

    if failed:
        ctx.fatal('Test run failed')


CONTEXTS = {
    'build'     : BuildContext,
    'clean'     : CleanContext,
    'install'   : InstallContext,
    'uninstall' : UninstallContext
}

def build_command(command):
    ctx, var = command.split('-')
    class _gen_command(CONTEXTS[ctx]):
        cmd = command
        variant = var

build_command('build-static')
build_command('build-shared')
build_command('build-test')

build_command('clean-static')
build_command('clean-shared')
build_command('clean-test')

build_command('install-static')
build_command('install-shared')

build_command('uninstall-static')
build_command('uninstall-shared')