build_common/external_libs.scons

   1 ##
   2 # This script manages external libraries
   3 #
   4 # Some methods are added to manage external packages:
   5 #    'PrepareLib': Checks the existence of an external library, if it
   6 # doesn't exist, calls the script user provided to download(if required)
   7 # and build the source code of the external library or notify user to
   8 # install the library.
   9 #   'Download': Download package from specify URL
  10 #   'UnpackAll': Unpack the package
  11 #   'Configure': Execute specify script(configure, bootstrap etc)
  12 #   'InstallHeadFile': Install head files
  13 #   'InstallLib': Install library binaries(.so, .a etc)
  14 #
  15 # By default, assume the script for an exteranl library is:
  16 #    <src_dir>/extlibs/<libname>/SConscript
  17 #
  18 # Note: After the external library is built:
  19 #   Head files should be installed to <src_dir>/deps/<target_os>/include
  20 #   lib(e.g .so, .a) should be installed to <src_dir>/deps/<target_os>/lib/<arch>
  21 #
  22 ##
  23 import os, subprocess
  24 import urllib2, urlparse
  25 import SCons.Errors
  26
  27 Import('env')
  28
  29 target_os = env.get('TARGET_OS')
  30 target_arch = env.get('TARGET_ARCH')
  31 rd_mode = env.get('RD_MODE')
  32
  33 # for android, doesn't distinguish 'armeabi-v7a-hard' and 'armeabi-v7a' library
  34 if target_os == 'android':
  35         if target_arch == 'armeabi-v7a-hard':
  36                 target_arch = 'armeabi-v7a'
  37
  38 if target_os == 'darwin':
  39         env.AppendUnique(CPPPATH = ['/usr/local/include'])
  40         env.AppendUnique(LIBPATH = ['/usr/local/lib'])
  41
  42 # External library include files are in <src_dir>/deps/<target_os>/include
  43 # the library binaries are in <src_dir>/deps/<target_os>/lib/<arch>
  44 if target_os not in ['windows']:
  45         env.AppendUnique(CPPPATH = [os.path.join(env.get('SRC_DIR'), 'deps', target_os, 'include')])
  46         env.AppendUnique(LIBPATH = [os.path.join(env.get('SRC_DIR'), 'deps', target_os, 'lib', target_arch)])
  47
  48 # Check whether a library exists, if not, notify user to install it or try to
  49 # download the source code and build it
  50 # @param libname - the name of the library try to prepare
  51 # @param lib - the lib(.so, .a etc) to check (a library may include more then
  52 #      one lib, e.g. boost, includes boost_thread, boost_system ...
  53 # @param path - the directory of the library building script, if it's not set,
  54 #                       by default, it's <src_dir>/extlibs/<libname>/
  55 # @param script - the building script, by default, it's 'SConscript'
  56 #
  57 def __prepare_lib(ienv, libname, lib = None, path = None, script = None):
  58         p_env = ienv.Clone()
  59         if p_env.GetOption('clean') or p_env.GetOption('help'):
  60                 return
  61
  62         conf = Configure(p_env)
  63
  64         if not lib:
  65                 lib = libname
  66         if not conf.CheckLib(lib):
  67                 if path:
  68                         dir = path
  69                 else:
  70                         dir = os.path.join(env.get('SRC_DIR'), 'extlibs', libname)
  71
  72                 # Execute the script to download(if required) and build source code
  73                 if script:
  74                         st = os.path.join(dir, script)
  75                 else:
  76                         st = os.path.join(dir, 'SConscript')
  77
  78                 if os.path.exists(st):
  79                         SConscript(st)
  80                 else:
  81                         if target_os in ['linux', 'darwin', 'tizen']:
  82                                 print 'Don\'t find library(%s), please intall it, exit ...' % libname
  83                         else:
  84                                 print 'Don\'t find library(%s) and don\'t find the process script (%s), exit ...' % (libname, st)
  85                         Exit(1)
  86
  87         conf.Finish()
  88
  89 # Run configure command (usually it's done before build a library)
  90 def __configure(env, cwd, cmd) :
  91         print "Configuring using [%s/%s] ..." % (cwd, cmd)
  92         # build it now (we need the shell, because some programs need it)
  93         devnull = open(os.devnull, "wb")
  94         handle  = subprocess.Popen(cmd, shell=True, cwd=cwd, stdout=devnull)
  95
  96         if handle.wait() <> 0 :
  97                 raise SCons.Errors.BuildError( "Run configuring script [%s]" % (cmd) )
  98
  99 # Download from URL 'url', will save as 'target'
 100 def __download(ienv, target, url) :
 101         if os.path.exists(target) :
 102                 return target
 103
 104         try :
 105                 print "Download %s from %s" % (target, url)
 106                 print "Downloading ..."
 107                 stream = urllib2.urlopen(url)
 108                 file = open(target, 'wb')
 109                 file.write(stream.read())
 110                 file.close()
 111                 print "Download %s from %s complete" % (target, url)
 112                 return target
 113         except Exception, e :
 114                 raise SCons.Errors.StopError( '%s [%s]' % (e, url) )
 115
 116 # Install header file(s) to <src_dir>/deps/<target_os>/include
 117 def __install_head_file(ienv, file):
 118                 return ienv.Install(os.path.join(env.get('SRC_DIR'), 'dep', target_os, target_arch, 'usr', 'include'), file)
 119
 120 # Install library binaries to <src_dir>/deps/<target_os>/lib/<arch>
 121 def __install_lib(ienv, lib):
 122                 return ienv.Install(os.path.join(env.get('SRC_DIR'), 'dep', target_os, target_arch, 'usr', 'lib'), lib)
 123
 124 SConscript('tools/UnpackAll.py')
 125
 126 # tinycbor build/fetch
 127 SConscript(os.path.join(env.get('SRC_DIR'), 'extlibs', 'tinycbor', 'SConscript'))
 128
 129 with_ra = env.get('WITH_RA')
 130 if with_ra:
 131         SConscript(os.path.join(env.get('SRC_DIR'), 'extlibs', 'raxmpp', 'SConscript'))
 132
 133 with_ra_ibb = env.get('WITH_RA_IBB')
 134 if with_ra_ibb:
 135         SConscript(os.path.join(env.get('SRC_DIR'), 'extlibs', 'wksxmppxep', 'SConscript'))
 136
 137
 138 env.AddMethod(__prepare_lib, "PrepareLib")
 139 env.AddMethod(__configure, "Configure")
 140 env.AddMethod(__download, "Download")
 141 env.AddMethod(__install_head_file, "InstallHeadFile")
 142 env.AddMethod(__install_lib, "InstallLib")
 143
 144 if env.get('SECURED') == '1' and target_os != 'tizen':
 145         SConscript(os.path.join(env.get('SRC_DIR'), 'extlibs', 'sqlite3', 'SConscript'))
 146
 147 if 'CLIENT' in rd_mode or 'SERVER' in rd_mode:
 148         if target_os not in ['tizen']:
 149                 SConscript(os.path.join(env.get('SRC_DIR'), 'extlibs', 'sqlite3', 'SConscript'))