wscript

#! /usr/bin/env python
#| This file is a part of the sferes2 framework.
#| Copyright 2009, ISIR / Universite Pierre et Marie Curie (UPMC)
#| Main contributor(s): Jean-Baptiste Mouret, mouret@isir.fr
#|
#| This software is a computer program whose purpose is to facilitate
#| experiments in evolutionary computation and evolutionary robotics.
#|
#| This software is governed by the CeCILL license under French law
#| and abiding by the rules of distribution of free software.  You
#| can use, modify and/ or redistribute the software under the terms
#| of the CeCILL license as circulated by CEA, CNRS and INRIA at the
#| following URL "http://www.cecill.info".
#|
#| As a counterpart to the access to the source code and rights to
#| copy, modify and redistribute granted by the license, users are
#| provided only with a limited warranty and the software's author,
#| the holder of the economic rights, and the successive licensors
#| have only limited liability.
#|
#| In this respect, the user's attention is drawn to the risks
#| associated with loading, using, modifying and/or developing or
#| reproducing the software by the user in light of its specific
#| status of free software, that may mean that it is complicated to
#| manipulate, and that also therefore means that it is reserved for
#| developers and experienced professionals having in-depth computer
#| knowledge. Users are therefore encouraged to load and test the
#| software's suitability as regards their requirements in conditions
#| enabling the security of their systems and/or data to be ensured
#| and, more generally, to use and operate it in the same conditions
#| as regards security.
#|
#| The fact that you are presently reading this means that you have
#| had knowledge of the CeCILL license and that you accept its terms.


import Options
import copy
import os, glob, types
import sferes
import tbb
import sys
import commands
import TaskGen, Task, Utils
from Constants import RUN_ME
import unittestw, Utils
import Configure

VERSION=commands.getoutput('git rev-parse HEAD')
if "No such " in VERSION or "fatal:" in VERSION:
    VERSION="0.x"
APPNAME='sferes2'

srcdir = '.'
blddir = 'build'

modules = sferes.parse_modules()

def init():
    pass

def set_options(opt):
    # tools
    opt.tool_options('compiler_cxx')
    opt.tool_options('boost_sferes')
    opt.tool_options('tbb')
    opt.tool_options('mpi')
    opt.tool_options('eigen3')
    opt.tool_options('unittest')

    # sferes specific
    opt.add_option('--bullet', type='string', help='path to bullet', dest='bullet')
    opt.add_option('--apple', type='string', help='enable apple support', dest='apple')
    opt.add_option('--rpath', type='string', help='set rpath', dest='rpath')
    opt.add_option('--includes', type='string', help='add an include path, e.g. /home/mandor/include', dest='includes')
    opt.add_option('--libs', type='string', help='add a lib path, e.g. /home/mandor/lib', dest='libs')
    opt.add_option('--cpp11', type='string', help='force c++-11 compilation [--cpp11=yes]', dest='cpp11')

    # exp commands
    opt.add_option('--create', type='string', help='create a new exp', dest='create_exp')
    opt.add_option('--exp', type='string', help='exp to build', dest='exp')
    opt.add_option('--launch', type='string', help='config file to launch', dest='launch')
    opt.add_option('--time_travel', type='string', help='config file to time-travel', dest='time_travel')
    opt.add_option('--kill', type='string', help='config file to kill', dest='kill')
    opt.add_option('--status', type='string', help='config file to status', dest='status')
    opt.add_option('--qsub', type='string', help='config file (json) to submit to torque', dest='qsub')
    opt.add_option('--ll', type='string', help='config file (json) to submit to loadleveler', dest='loadleveler')

    for i in modules:
        print 'module : [' + i + ']'
        opt.sub_options(i)


def configure(conf):
    # log configure options
    fname = blddir + '/configure.options'
    args = open(fname, 'a')
    for i in sys.argv:
        args.write(i + ' ')
    args.write("\n")
    args.close()

    conf.check_tool('compiler_cxx')

    common_flags = "-D_REENTRANT -Wall -fPIC -ftemplate-depth-1024 -Wno-sign-compare -Wno-deprecated  -Wno-unused "
    if Options.options.cpp11 and Options.options.cpp11 == 'yes':
        common_flags += '-std=c++11 '

    # boost
    conf.check_tool('boost_sferes')
    conf.check_boost(lib='serialization filesystem system unit_test_framework program_options graph mpi python thread',
                     min_version='1.35')
    # tbb
    conf.check_tool('tbb')

    # mpi.h
    mpi_found = conf.check_tool('mpi')

    # boost mpi
    if (len(conf.env['LIB_BOOST_MPI']) != 0 and conf.env['MPI_FOUND']):
        conf.env['MPI_ENABLED'] = True
    else:
        conf.env['MPI_ENABLED'] = False

    # sdl (optional)
    sdl = conf.check_cfg(package='sdl',
                   args='--cflags --libs',
                   msg="Checking for SDL (optional)",
                   uselib_store='SDL',
                   mandatory=False)
    if sdl: common_flags += '-DUSE_SDL '

    conf.env['CCDEFINES_SDL_gfx']=['_GNU_SOURCE=1', '_REENTRANT']
    conf.env['CPPPATH_SDL_gfx']=['/usr/include/SDL']
    conf.env['LIBPATH_SDL_gfx']=['/usr/lib']
    conf.env['CXXDEFINES_SDL_gfx']=['_GNU_SOURCE=1', '_REENTRANT']
    conf.env['LIB_SDL_gfx']=['SDL_gfx']
    conf.env['HAVE_SDL_gfx']=1

    # eigen 3 (optional)
    eigen3_found = conf.check_tool('eigen3')

    # ode (optiona)
    ode_found = conf.check_tool('ode')

    # gsl (optional)
    conf.check_cfg(package='gsl',
                   args='--cflags --libs',
                   msg="Checking for GSL (optional)",
                   uselib_store='GSL',
                   mandatory=False)

    # bullet (optional)
    conf.env['LIB_BULLET'] = ['bulletdynamics', 'bulletcollision', 'bulletmath']
    if Options.options.bullet :
        conf.env['LIBPATH_BULLET'] = Options.options.bullet + '/lib'
        conf.env['CPPPATH_BULLET'] = Options.options.bullet + '/src'

    # osg (optional)
    conf.env['LIB_OSG'] = ['osg', 'osgDB', 'osgUtil',
                           'osgViewer', 'OpenThreads',
                           'osgFX', 'osgShadow']


    # Mac OS specific options
    if Options.options.apple and Options.options.apple == 'yes':
        common_flags += ' -Wno-gnu-static-float-init '

    conf.env['LIB_TCMALLOC'] = 'tcmalloc'
    conf.env['LIB_PTMALLOC'] = 'ptmalloc3'

    conf.env['LIB_EFENCE'] = 'efence'
    conf.env['LIB_BZIP2'] = 'bz2'
    conf.env['LIB_ZLIB'] = 'z'

    conf.env['LIBPATH_OPENGL'] = '/usr/X11R6/lib'
    conf.env['LIB_OPENGL'] = ['GL', 'GLU', 'glut']

    if Options.options.rpath:
        conf.env.append_value("LINKFLAGS", "--rpath="+Options.options.rpath)

    # modules
    for i in modules:
        conf.sub_config(i)

    # link flags
    if Options.options.libs:
        conf.env.append_value("LINKFLAGS", "-L" + Options.options.libs)

    if Options.options.includes :
        common_flags += " -I" + Options.options.includes + ' '
    if conf.env['MPI_ENABLED']:
        common_flags += '-DMPI_ENABLED '
    if not conf.env['TBB_ENABLED']:
        common_flags += '-DNO_PARALLEL '
    if conf.env['EIGEN3_FOUND']:
        common_flags += '-DEIGEN3_ENABLED '

    common_flags += "-DSFERES_ROOT=\"" + os.getcwd() + "\" "

    cxxflags = conf.env['CXXFLAGS']
    # release
    conf.setenv('default')
    opt_flags = common_flags +  ' -DNDEBUG -O3 -ffast-math'

    conf.env['CXXFLAGS'] = cxxflags + opt_flags.split(' ')
    conf.env['SFERES_ROOT'] = os.getcwd()

    # debug
    env = conf.env.copy()
    env.set_variant('debug')
    conf.set_env_name('debug', env)
    conf.setenv('debug')
    debug_flags = common_flags + '-O1 -ggdb3 -DDBG_ENABLED'
    conf.env['CXXFLAGS'] = cxxflags + debug_flags.split(' ')

    # display flags
    def flat(list) :
        str = ""
        for i in list :
            str += i + ' '
        return str
    print '\n--- configuration ---'
    print 'compiler:'
    print' * CXX: ' + str(conf.env['CXX_NAME'])
    print 'boost version: ' + str(conf.env['BOOST_VERSION'])
    print 'mpi: ' + str(conf.env['MPI_ENABLED'])
    print "Compilation flags :"
    conf.setenv('default')
    print " * default:"
    print "   CXXFLAGS : " + flat(conf.env['CXXFLAGS'])
    print "   LINKFLAGS: " + flat(conf.env['LINKFLAGS'])
    conf.setenv('debug')
    print " * debug:"
    print "   CXXFLAGS : " + flat(conf.env['CXXFLAGS'])
    print "   LINKFLAGS: " + flat(conf.env['LINKFLAGS'])
    print " "
    print "--- license ---"
    print "Sferes2 is distributed under the CECILL license (GPL-compatible)"
    print "Please check the accompagnying COPYING file or http://www.cecill.info/"

def build(bld):
    v = commands.getoutput('git rev-parse HEAD')
    bld.env_of_name('default')['CXXFLAGS'].append("-DVERSION=\"(const char*)\\\""+v+"\\\"\"")
    bld.env_of_name('debug')['CXXFLAGS'].append("-DVERSION=\"(const char*)\\\""+v+"\\\"\"")

    print ("Entering directory `" + os.getcwd() + "'")
    bld.add_subdirs('sferes examples tests')
    if Options.options.exp:
        print 'Building exp: ' + Options.options.exp
        bld.add_subdirs('exp/' + Options.options.exp)
    for i in modules:
        bld.add_subdirs(i)
    for obj in copy.copy(bld.all_task_gen):
        new_obj = obj.clone('debug')
    bld.add_post_fun(unittestw.summary)

def shutdown ():
    if Options.options.create_exp:
        sferes.create_exp(Options.options.create_exp)
    if Options.options.launch:
        sferes.launch_exp(Options.options.launch)
    if Options.options.status:
        sferes.status(Options.options.status)
    if Options.options.time_travel:
        sferes.time_travel(Options.options.time_travel)
    if Options.options.kill:
        sferes.kill(Options.options.kill)
    if Options.options.qsub:
        sferes.qsub(Options.options.qsub)
    if Options.options.loadleveler:
        sferes.loadleveler(Options.options.loadleveler)


def check(self):
    os.environ["BOOST_TEST_CATCH_SYSTEM_ERRORS"]="no"
    os.environ["BOOST_TEST_LOG_LEVEL"]="test_suite"
    ut = unittestw.unit_test()
    ut.change_to_testfile_dir = True
    ut.want_to_see_test_output = True
    ut.want_to_see_test_error = True
    ut.run()
    ut.print_results()