build_files/scons/tools/btools.py

   1 import os
   2 import os.path
   3 import SCons.Options
   4
   5 import SCons.Variables
   6 try:
   7     import subprocess
   8 except ImportError:
   9     pass
  10 import string
  11 import glob
  12 import shutil
  13 import sys
  14
  15 Variables = SCons.Variables
  16 BoolVariable = SCons.Variables.BoolVariable
  17
  18 def get_version():
  19     import re
  20
  21     fname = os.path.join(os.path.dirname(__file__), "..", "..", "..", "source", "blender", "blenkernel", "BKE_blender.h")
  22     ver_base = None
  23     ver_char = None
  24     ver_cycle = None
  25
  26     re_ver = re.compile("^#\s*define\s+BLENDER_VERSION\s+([0-9]+)")
  27     re_ver_char = re.compile("^#\s*define\s+BLENDER_VERSION_CHAR\s*(\S*)") # optional arg
  28     re_ver_cycle = re.compile("^#\s*define\s+BLENDER_VERSION_CYCLE\s*(\S*)") # optional arg
  29
  30     for l in open(fname, "r"):
  31         match = re_ver.match(l)
  32         if match:
  33             ver = int(match.group(1))
  34             ver_base = "%d.%d" % (ver / 100, ver % 100)
  35
  36         match = re_ver_char.match(l)
  37         if match:
  38             ver_char = match.group(1)
  39             if ver_char == "BLENDER_CHAR_VERSION":
  40                 ver_char = ""
  41
  42         match = re_ver_cycle.match(l)
  43         if match:
  44             ver_cycle = match.group(1)
  45             if ver_cycle == "BLENDER_CYCLE_VERSION":
  46                 ver_cycle = ""
  47
  48         if (ver_base is not None) and (ver_char is not None) and (ver_cycle is not None):
  49             # eg '2.56a-beta'
  50             if ver_cycle:
  51                 ver_display = "%s%s-%s" % (ver_base, ver_char, ver_cycle)
  52             else:
  53                 ver_display = "%s%s" % (ver_base, ver_char)  # assume release
  54
  55             return ver_base, ver_display
  56
  57     raise Exception("%s: missing version string" % fname)
  58
  59 def get_revision():
  60     build_rev = os.popen('svnversion').read()[:-1] # remove \n
  61     if build_rev == '' or build_rev==None:
  62         build_rev = 'UNKNOWN'
  63
  64     return 'r' + build_rev
  65
  66
  67 # copied from: http://www.scons.org/wiki/AutoconfRecipes
  68 def checkEndian():
  69     import struct
  70     array = struct.pack('cccc', '\x01', '\x02', '\x03', '\x04')
  71     i = struct.unpack('i', array)
  72     # Little Endian
  73     if i == struct.unpack('<i', array):
  74         return "little"
  75     # Big Endian
  76     elif i == struct.unpack('>i', array):
  77         return "big"
  78     else:
  79         raise Exception("cant find endian")
  80
  81
  82 # This is used in creating the local config directories
  83 VERSION, VERSION_DISPLAY = get_version()
  84 REVISION = get_revision()
  85 ENDIAN = checkEndian()
  86
  87
  88 def print_arguments(args, bc):
  89     if len(args):
  90         for k,v in args.iteritems():
  91             if type(v)==list:
  92                 v = ' '.join(v)
  93             print '\t'+bc.OKBLUE+k+bc.ENDC+' = '+bc.OKGREEN + v + bc.ENDC
  94     else:
  95         print '\t'+bc.WARNING+'No  command-line arguments given'+bc.ENDC
  96
  97 def validate_arguments(args, bc):
  98     opts_list = [
  99             'WITH_BF_PYTHON', 'WITH_BF_PYTHON_SAFETY', 'BF_PYTHON', 'BF_PYTHON_VERSION', 'BF_PYTHON_INC', 'BF_PYTHON_BINARY', 'BF_PYTHON_LIB', 'BF_PYTHON_LIBPATH', 'WITH_BF_STATICPYTHON', 'WITH_OSX_STATICPYTHON', 'BF_PYTHON_LIB_STATIC', 'BF_PYTHON_DLL', 'BF_PYTHON_ABI_FLAGS',
 100             'WITH_BF_OPENAL', 'BF_OPENAL', 'BF_OPENAL_INC', 'BF_OPENAL_LIB', 'BF_OPENAL_LIBPATH', 'WITH_BF_STATICOPENAL', 'BF_OPENAL_LIB_STATIC',
 101             'WITH_BF_SDL', 'BF_SDL', 'BF_SDL_INC', 'BF_SDL_LIB', 'BF_SDL_LIBPATH',
 102             'WITH_BF_JACK', 'BF_JACK', 'BF_JACK_INC', 'BF_JACK_LIB', 'BF_JACK_LIBPATH',
 103             'WITH_BF_SNDFILE', 'BF_SNDFILE', 'BF_SNDFILE_INC', 'BF_SNDFILE_LIB', 'BF_SNDFILE_LIBPATH', 'WITH_BF_STATICSNDFILE', 'BF_SNDFILE_LIB_STATIC',
 104             'BF_PTHREADS', 'BF_PTHREADS_INC', 'BF_PTHREADS_LIB', 'BF_PTHREADS_LIBPATH',
 105             'WITH_BF_OPENEXR', 'BF_OPENEXR', 'BF_OPENEXR_INC', 'BF_OPENEXR_LIB', 'BF_OPENEXR_LIBPATH', 'WITH_BF_STATICOPENEXR', 'BF_OPENEXR_LIB_STATIC',
 106             'WITH_BF_DDS', 'WITH_BF_CINEON', 'WITH_BF_HDR',
 107             'WITH_BF_FFMPEG', 'BF_FFMPEG_LIB','BF_FFMPEG_EXTRA', 'BF_FFMPEG',  'BF_FFMPEG_INC', 'BF_FFMPEG_DLL',
 108             'WITH_BF_STATICFFMPEG', 'BF_FFMPEG_LIB_STATIC',
 109             'WITH_BF_OGG', 'BF_OGG', 'BF_OGG_LIB',
 110             'WITH_BF_JPEG', 'BF_JPEG', 'BF_JPEG_INC', 'BF_JPEG_LIB', 'BF_JPEG_LIBPATH',
 111             'WITH_BF_OPENJPEG', 'BF_OPENJPEG', 'BF_OPENJPEG_INC', 'BF_OPENJPEG_LIB', 'BF_OPENJPEG_LIBPATH',
 112             'WITH_BF_REDCODE', 'BF_REDCODE', 'BF_REDCODE_INC', 'BF_REDCODE_LIB', 'BF_REDCODE_LIBPATH',
 113             'WITH_BF_PNG', 'BF_PNG', 'BF_PNG_INC', 'BF_PNG_LIB', 'BF_PNG_LIBPATH',
 114             'WITH_BF_TIFF', 'BF_TIFF', 'BF_TIFF_INC', 'BF_TIFF_LIB', 'BF_TIFF_LIBPATH', 'WITH_BF_STATICTIFF', 'BF_TIFF_LIB_STATIC',
 115             'WITH_BF_ZLIB', 'BF_ZLIB', 'BF_ZLIB_INC', 'BF_ZLIB_LIB', 'BF_ZLIB_LIBPATH', 'WITH_BF_STATICZLIB', 'BF_ZLIB_LIB_STATIC',
 116             'WITH_BF_INTERNATIONAL',
 117             'BF_GETTEXT', 'BF_GETTEXT_INC', 'BF_GETTEXT_LIB', 'WITH_BF_GETTEXT_STATIC', 'BF_GETTEXT_LIB_STATIC', 'BF_GETTEXT_LIBPATH',
 118             'WITH_BF_ICONV', 'BF_ICONV', 'BF_ICONV_INC', 'BF_ICONV_LIB', 'BF_ICONV_LIBPATH',
 119             'WITH_BF_GAMEENGINE',
 120             'WITH_BF_BULLET', 'BF_BULLET', 'BF_BULLET_INC', 'BF_BULLET_LIB',
 121             'WITH_BF_ELTOPO',
 122             'BF_WINTAB', 'BF_WINTAB_INC',
 123             'BF_FREETYPE', 'BF_FREETYPE_INC', 'BF_FREETYPE_LIB', 'BF_FREETYPE_LIBPATH', 'BF_FREETYPE_LIB_STATIC', 'WITH_BF_FREETYPE_STATIC',
 124             'WITH_BF_QUICKTIME', 'BF_QUICKTIME', 'BF_QUICKTIME_INC', 'BF_QUICKTIME_LIB', 'BF_QUICKTIME_LIBPATH',
 125             'WITH_BF_FFTW3', 'BF_FFTW3', 'BF_FFTW3_INC', 'BF_FFTW3_LIB', 'BF_FFTW3_LIBPATH', 'WITH_BF_STATICFFTW3', 'BF_FFTW3_LIB_STATIC',
 126             'WITH_BF_STATICOPENGL', 'BF_OPENGL', 'BF_OPENGL_INC', 'BF_OPENGL_LIB', 'BF_OPENGL_LIBPATH', 'BF_OPENGL_LIB_STATIC',
 127             'WITH_BF_COLLADA', 'BF_COLLADA', 'BF_COLLADA_INC', 'BF_COLLADA_LIB', 'BF_OPENCOLLADA', 'BF_OPENCOLLADA_INC', 'BF_OPENCOLLADA_LIB', 'BF_OPENCOLLADA_LIBPATH', 'BF_PCRE', 'BF_PCRE_LIB', 'BF_PCRE_LIBPATH', 'BF_EXPAT', 'BF_EXPAT_LIB', 'BF_EXPAT_LIBPATH',
 128             'WITH_BF_PLAYER',
 129             'WITH_BF_NOBLENDER',
 130             'WITH_BF_BINRELOC',
 131             'WITH_BF_LZO', 'WITH_BF_LZMA',
 132             'LCGDIR',
 133             'BF_CXX', 'WITH_BF_STATICCXX', 'BF_CXX_LIB_STATIC',
 134             'BF_TWEAK_MODE', 'BF_SPLIT_SRC',
 135             'WITHOUT_BF_INSTALL',
 136             'WITHOUT_BF_PYTHON_INSTALL',
 137             'WITHOUT_BF_OVERWRITE_INSTALL',
 138             'WITH_BF_OPENMP', 'BF_OPENMP', 'BF_OPENMP_LIBPATH',
 139             'WITH_GHOST_COCOA',
 140             'WITH_GHOST_SDL',
 141             'BF_GHOST_DEBUG',
 142             'USE_QTKIT',
 143             'BF_FANCY', 'BF_QUIET', 'BF_LINE_OVERWRITE',
 144             'BF_X264_CONFIG',
 145             'BF_XVIDCORE_CONFIG',
 146             'WITH_BF_DOCS',
 147             'BF_NUMJOBS',
 148             'BF_MSVS',
 149             'BF_VERSION',
 150             'WITH_BF_RAYOPTIMIZATION',
 151             'BF_RAYOPTIMIZATION_SSE_FLAGS',
 152             'WITH_BF_FLUID',
 153             'WITH_BF_DECIMATE',
 154             'WITH_BF_BOOLEAN',
 155             'WITH_BF_CXX_GUARDEDALLOC',
 156             'WITH_BF_JEMALLOC', 'WITH_BF_STATICJEMALLOC', 'BF_JEMALLOC', 'BF_JEMALLOC_INC', 'BF_JEMALLOC_LIBPATH', 'BF_JEMALLOC_LIB', 'BF_JEMALLOC_LIB_STATIC',
 157             'BUILDBOT_BRANCH',
 158             'WITH_BF_3DMOUSE', 'WITH_BF_STATIC3DMOUSE', 'BF_3DMOUSE', 'BF_3DMOUSE_INC', 'BF_3DMOUSE_LIB', 'BF_3DMOUSE_LIBPATH', 'BF_3DMOUSE_LIB_STATIC',
 159             'WITH_BF_CYCLES',
 160             'WITH_BF_OIIO', 'BF_OIIO', 'BF_OIIO_INC', 'BF_OIIO_LIB', 'BF_OIIO_LIBPATH',
 161             'WITH_BF_BOOST', 'BF_BOOST', 'BF_BOOST_INC', 'BF_BOOST_LIB', 'BF_BOOST_LIBPATH'
 162             ]
 163
 164     # Have options here that scons expects to be lists
 165     opts_list_split = [
 166             'BF_PYTHON_LINKFLAGS',
 167             'BF_OPENGL_LINKFLAGS',
 168             'CFLAGS', 'CCFLAGS', 'CXXFLAGS', 'CPPFLAGS',
 169             'REL_CFLAGS', 'REL_CCFLAGS', 'REL_CXXFLAGS',
 170             'BGE_CXXFLAGS',
 171             'BF_PROFILE_CFLAGS', 'BF_PROFILE_CCFLAGS', 'BF_PROFILE_CXXFLAGS', 'BF_PROFILE_LINKFLAGS',
 172             'BF_DEBUG_CFLAGS', 'BF_DEBUG_CCFLAGS', 'BF_DEBUG_CXXFLAGS',
 173             'C_WARN', 'CC_WARN', 'CXX_WARN',
 174             'LLIBS', 'PLATFORM_LINKFLAGS','MACOSX_ARCHITECTURE', 'MACOSX_SDK_CHECK', 'XCODE_CUR_VER',
 175     ]
 176
 177
 178     arg_list = ['BF_DEBUG', 'BF_QUIET', 'BF_CROSS', 'BF_UPDATE',
 179             'BF_INSTALLDIR', 'BF_TOOLSET', 'BF_BINNAME',
 180             'BF_BUILDDIR', 'BF_FANCY', 'BF_QUICK', 'BF_PROFILE', 'BF_LINE_OVERWRITE',
 181             'BF_BSC', 'BF_CONFIG',
 182             'BF_PRIORITYLIST', 'BF_BUILDINFO','CC', 'CXX', 'BF_QUICKDEBUG',
 183             'BF_LISTDEBUG', 'LCGDIR', 'BF_X264_CONFIG', 'BF_XVIDCORE_CONFIG',
 184             'BF_UNIT_TEST', 'BF_BITNESS']
 185
 186     okdict = {}
 187
 188     for k,v in args.iteritems():
 189         if (k in opts_list) or (k in arg_list):
 190             okdict[k] = v
 191         elif k in opts_list_split:
 192             okdict[k] = v.split() # "" have already been stripped
 193         else:
 194             print '\t'+bc.WARNING+'Invalid argument: '+bc.ENDC+k+'='+v
 195
 196     return okdict
 197
 198 def print_targets(targs, bc):
 199     if len(targs)>0:
 200         for t in targs:
 201             print '\t'+bc.OKBLUE+t+bc.ENDC
 202     else:
 203         print '\t'+bc.WARNING+'No targets given, using '+bc.ENDC+bc.OKGREEN+'default'+bc.ENDC
 204
 205 def validate_targets(targs, bc):
 206     valid_list = ['.', 'blender', 'blenderstatic', 'blenderplayer', 'webplugin',
 207             'blendernogame', 'blenderstaticnogame', 'blenderlite', 'release',
 208             'everything', 'clean', 'install-bin', 'install', 'nsis','buildslave']
 209     oklist = []
 210     for t in targs:
 211         if t in valid_list:
 212             oklist.append(t)
 213         else:
 214             print '\t'+bc.WARNING+'Invalid target: '+bc.ENDC+t
 215     return oklist
 216
 217 class ourSpawn:
 218     def ourspawn(self, sh, escape, cmd, args, env):
 219         newargs = string.join(args[1:], ' ')
 220         cmdline = cmd + " " + newargs
 221         startupinfo = subprocess.STARTUPINFO()
 222         startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
 223         proc = subprocess.Popen(cmdline, stdin=subprocess.PIPE, stdout=subprocess.PIPE,
 224             stderr=subprocess.PIPE, startupinfo=startupinfo, shell = False)
 225         data, err = proc.communicate()
 226         rv = proc.wait()
 227         if rv:
 228             print "====="
 229             print err
 230             print "====="
 231         return rv
 232
 233 def SetupSpawn( env ):
 234     buf = ourSpawn()
 235     buf.ourenv = env
 236     env['SPAWN'] = buf.ourspawn
 237
 238
 239 def read_opts(env, cfg, args):
 240     localopts = Variables.Variables(cfg, args)
 241     localopts.AddVariables(
 242         ('LCGDIR', 'location of cvs lib dir'),
 243         (BoolVariable('WITH_BF_PYTHON', 'Compile with python', True)),
 244         (BoolVariable('WITH_BF_PYTHON_SAFETY', 'Internal API error checking to track invalid data to prevent crash on access (at the expense of some effeciency)', False)),
 245         ('BF_PYTHON', 'Base path for python', ''),
 246         ('BF_PYTHON_VERSION', 'Python version to use', ''),
 247         ('BF_PYTHON_INC', 'Include path for Python headers', ''),
 248         ('BF_PYTHON_BINARY', 'Path to the Python interpreter', ''),
 249         ('BF_PYTHON_LIB', 'Python library', ''),
 250         ('BF_PYTHON_DLL', 'Python dll - used on Windows only', ''),
 251         ('BF_PYTHON_LIB_STATIC', 'Python static libraries', ''),
 252         ('BF_PYTHON_LIBPATH', 'Library path', ''),
 253         ('BF_PYTHON_LINKFLAGS', 'Python link flags', ''),
 254         (BoolVariable('WITH_BF_STATICPYTHON', 'Staticly link to python', False)),
 255         (BoolVariable('WITH_OSX_STATICPYTHON', 'Staticly link to python', True)),
 256         ('BF_PYTHON_ABI_FLAGS', 'Python ABI flags (suffix in library version: m, mu, etc)', ''),
 257
 258         (BoolVariable('WITH_BF_FLUID', 'Build with Fluid simulation (Elbeem)', True)),
 259         (BoolVariable('WITH_BF_DECIMATE', 'Build with decimate modifier', True)),
 260         (BoolVariable('WITH_BF_BOOLEAN', 'Build with boolean modifier', True)),
 261         ('BF_PROFILE_FLAGS', 'Profiling compiler flags', ''),
 262         (BoolVariable('WITH_BF_OPENAL', 'Use OpenAL if true', False)),
 263         ('BF_OPENAL', 'Base path for OpenAL', ''),
 264         ('BF_OPENAL_INC', 'Include path for python headers', ''),
 265         ('BF_OPENAL_LIB', 'Path to OpenAL library', ''),
 266         ('BF_OPENAL_LIB_STATIC', 'Path to OpenAL static library', ''),
 267         ('BF_OPENAL_LIBPATH', 'Path to OpenAL library', ''),
 268         (BoolVariable('WITH_BF_STATICOPENAL', 'Staticly link to openal', False)),
 269
 270         (BoolVariable('WITH_BF_SDL', 'Use SDL if true', False)),
 271         ('BF_SDL', 'SDL base path', ''),
 272         ('BF_SDL_INC', 'SDL include path', ''),
 273         ('BF_SDL_LIB', 'SDL library', ''),
 274         ('BF_SDL_LIBPATH', 'SDL library path', ''),
 275
 276         (BoolVariable('WITH_BF_JACK', 'Enable jack support if true', True)),
 277         ('BF_JACK', 'jack base path', ''),
 278         ('BF_JACK_INC', 'jack include path', ''),
 279         ('BF_JACK_LIB', 'jack library', ''),
 280         ('BF_JACK_LIBPATH', 'jack library path', ''),
 281
 282         (BoolVariable('WITH_BF_SNDFILE', 'Enable sndfile support if true', True)),
 283         ('BF_SNDFILE', 'sndfile base path', ''),
 284         ('BF_SNDFILE_INC', 'sndfile include path', ''),
 285         ('BF_SNDFILE_LIB', 'sndfile library', ''),
 286         ('BF_SNDFILE_LIB_STATIC', 'Path to sndfile static library', ''),
 287         ('BF_SNDFILE_LIBPATH', 'sndfile library path', ''),
 288         (BoolVariable('WITH_BF_STATICSNDFILE', 'Staticly link to sndfile', False)),
 289
 290         ('BF_PTHREADS', 'Pthreads base path', ''),
 291         ('BF_PTHREADS_INC', 'Pthreads include path', ''),
 292         ('BF_PTHREADS_LIB', 'Pthreads library', ''),
 293         ('BF_PTHREADS_LIBPATH', 'Pthreads library path', ''),
 294
 295         (BoolVariable('WITH_BF_OPENEXR', 'Use OPENEXR if true', True)),
 296         (BoolVariable('WITH_BF_STATICOPENEXR', 'Staticly link to OpenEXR', False)),
 297         ('BF_OPENEXR', 'OPENEXR base path', ''),
 298         ('BF_OPENEXR_INC', 'OPENEXR include path', ''),
 299         ('BF_OPENEXR_LIB', 'OPENEXR library', ''),
 300         ('BF_OPENEXR_LIBPATH', 'OPENEXR library path', ''),
 301         ('BF_OPENEXR_LIB_STATIC', 'OPENEXR static library', ''),
 302
 303         (BoolVariable('WITH_BF_DDS', 'Support DDS image format if true', True)),
 304
 305         (BoolVariable('WITH_BF_CINEON', 'Support CINEON and DPX image formats if true', True)),
 306
 307         (BoolVariable('WITH_BF_HDR', 'Support HDR image formats if true', True)),
 308
 309         (BoolVariable('WITH_BF_FFMPEG', 'Use FFMPEG if true', False)),
 310         ('BF_FFMPEG', 'FFMPEG base path', ''),
 311         ('BF_FFMPEG_LIB', 'FFMPEG library', ''),
 312         ('BF_FFMPEG_DLL', 'FFMPEG dll libraries to be installed', ''),
 313         ('BF_FFMPEG_EXTRA', 'FFMPEG flags that must be preserved', ''),
 314
 315         ('BF_FFMPEG_INC', 'FFMPEG includes', ''),
 316         ('BF_FFMPEG_LIBPATH', 'FFMPEG library path', ''),
 317         (BoolVariable('WITH_BF_STATICFFMPEG', 'Use static FFMPEG if true', False)),
 318         ('BF_FFMPEG_LIB_STATIC', 'Static FFMPEG libraries', ''),
 319
 320         (BoolVariable('WITH_BF_OGG', 'Use OGG, THEORA, VORBIS in FFMPEG if true',
 321                     False)),
 322         ('BF_OGG', 'OGG base path', ''),
 323         ('BF_OGG_LIB', 'OGG library', ''),
 324
 325         (BoolVariable('WITH_BF_JPEG', 'Use JPEG if true', True)),
 326         ('BF_JPEG', 'JPEG base path', ''),
 327         ('BF_JPEG_INC', 'JPEG include path', ''),
 328         ('BF_JPEG_LIB', 'JPEG library', ''),
 329         ('BF_JPEG_LIBPATH', 'JPEG library path', ''),
 330
 331         (BoolVariable('WITH_BF_OPENJPEG', 'Use OPENJPEG if true', False)),
 332         ('BF_OPENJPEG', 'OPENJPEG base path', ''),
 333         ('BF_OPENJPEG_INC', 'OPENJPEG include path', ''),
 334         ('BF_OPENJPEG_LIB', 'OPENJPEG library', ''),
 335         ('BF_OPENJPEG_LIBPATH', 'OPENJPEG library path', ''),
 336
 337         (BoolVariable('WITH_BF_REDCODE', 'Use REDCODE if true', False)),
 338         ('BF_REDCODE', 'REDCODE base path', ''),
 339         ('BF_REDCODE_INC', 'REDCODE include path', ''),
 340         ('BF_REDCODE_LIB', 'REDCODE library', ''),
 341         ('BF_REDCODE_LIBPATH', 'REDCODE library path', ''),
 342
 343         (BoolVariable('WITH_BF_PNG', 'Use PNG if true', True)),
 344         ('BF_PNG', 'PNG base path', ''),
 345         ('BF_PNG_INC', 'PNG include path', ''),
 346         ('BF_PNG_LIB', 'PNG library', ''),
 347         ('BF_PNG_LIBPATH', 'PNG library path', ''),
 348
 349         (BoolVariable('WITH_BF_TIFF', 'Use TIFF if true', True)),
 350         (BoolVariable('WITH_BF_STATICTIFF', 'Staticly link to TIFF', False)),
 351         ('BF_TIFF', 'TIFF base path', ''),
 352         ('BF_TIFF_INC', 'TIFF include path', ''),
 353         ('BF_TIFF_LIB', 'TIFF library', ''),
 354         ('BF_TIFF_LIBPATH', 'TIFF library path', ''),
 355         ('BF_TIFF_LIB_STATIC', 'TIFF static library', ''),
 356
 357         (BoolVariable('WITH_BF_ZLIB', 'Use ZLib if true', True)),
 358         (BoolVariable('WITH_BF_STATICZLIB', 'Staticly link to ZLib', False)),
 359         ('BF_ZLIB', 'ZLib base path', ''),
 360         ('BF_ZLIB_INC', 'ZLib include path', ''),
 361         ('BF_ZLIB_LIB', 'ZLib library', ''),
 362         ('BF_ZLIB_LIBPATH', 'ZLib library path', ''),
 363         ('BF_ZLIB_LIB_STATIC', 'ZLib static library', ''),
 364
 365         (BoolVariable('WITH_BF_INTERNATIONAL', 'Use Gettext if true', True)),
 366
 367         ('BF_GETTEXT', 'gettext base path', ''),
 368         ('BF_GETTEXT_INC', 'gettext include path', ''),
 369         ('BF_GETTEXT_LIB', 'gettext library', ''),
 370         (BoolVariable('WITH_BF_GETTEXT_STATIC', 'Use static gettext library if true', False)),
 371         ('BF_GETTEXT_LIB_STATIC', 'static gettext library', ''),
 372         ('BF_GETTEXT_LIBPATH', 'gettext library path', ''),
 373
 374         (BoolVariable('WITH_BF_ICONV', 'Use iconv if true', True)),
 375         ('BF_ICONV', 'iconv base path', ''),
 376         ('BF_ICONV_INC', 'iconv include path', ''),
 377         ('BF_ICONV_LIB', 'iconv library', ''),
 378         ('BF_ICONV_LIBPATH', 'iconv library path', ''),
 379
 380         (BoolVariable('WITH_BF_GAMEENGINE', 'Build with gameengine' , False)),
 381
 382         (BoolVariable('WITH_BF_BULLET', 'Use Bullet if true', True)),
 383         (BoolVariable('WITH_BF_ELTOPO', 'Use Eltopo collision library if true', False)),
 384
 385         ('BF_BULLET', 'Bullet base dir', ''),
 386         ('BF_BULLET_INC', 'Bullet include path', ''),
 387         ('BF_BULLET_LIB', 'Bullet library', ''),
 388
 389         ('BF_WINTAB', 'WinTab base dir', ''),
 390         ('BF_WINTAB_INC', 'WinTab include dir', ''),
 391         ('BF_CXX', 'c++ base path for libstdc++, only used when static linking', ''),
 392         (BoolVariable('WITH_BF_STATICCXX', 'static link to stdc++', False)),
 393         ('BF_CXX_LIB_STATIC', 'static library path for stdc++', ''),
 394
 395         ('BF_FREETYPE', 'Freetype base path', ''),
 396         ('BF_FREETYPE_INC', 'Freetype include path', ''),
 397         ('BF_FREETYPE_LIB', 'Freetype library', ''),
 398         ('BF_FREETYPE_LIBPATH', 'Freetype library path', ''),
 399         (BoolVariable('WITH_BF_FREETYPE_STATIC', 'Use Static Freetype if true', False)),
 400         ('BF_FREETYPE_LIB_STATIC', 'Static Freetype library', ''),
 401
 402         (BoolVariable('WITH_BF_OPENMP', 'Use OpenMP if true', False)),
 403         ('BF_OPENMP', 'Base path to OpenMP (used when cross-compiling with older versions of WinGW)', ''),
 404         ('BF_OPENMP_INC', 'Path to OpenMP includes (used when cross-compiling with older versions of WinGW)', ''),
 405         ('BF_OPENMP_LIBPATH', 'Path to OpenMP libraries (used when cross-compiling with older versions of WinGW)', ''),
 406         (BoolVariable('WITH_GHOST_COCOA', 'Use Cocoa-framework if true', False)),
 407         (BoolVariable('WITH_GHOST_SDL', 'Enable building blender against SDL for windowing rather then the native APIs', False)),
 408         (BoolVariable('USE_QTKIT', 'Use QTKIT if true', False)),
 409
 410         (BoolVariable('WITH_BF_QUICKTIME', 'Use QuickTime if true', False)),
 411         ('BF_QUICKTIME', 'QuickTime base path', ''),
 412         ('BF_QUICKTIME_INC', 'QuickTime include path', ''),
 413         ('BF_QUICKTIME_LIB', 'QuickTime library', ''),
 414         ('BF_QUICKTIME_LIBPATH', 'QuickTime library path', ''),
 415
 416         (BoolVariable('WITH_BF_FFTW3', 'Use FFTW3 if true', False)),
 417         ('BF_FFTW3', 'FFTW3 base path', ''),
 418         ('BF_FFTW3_INC', 'FFTW3 include path', ''),
 419         ('BF_FFTW3_LIB', 'FFTW3 library', ''),
 420         ('BF_FFTW3_LIB_STATIC', 'FFTW3 static libraries', ''),
 421         ('BF_FFTW3_LIBPATH', 'FFTW3 library path', ''),
 422         (BoolVariable('WITH_BF_STATICFFTW3', 'Staticly link to FFTW3', False)),
 423
 424         (BoolVariable('WITH_BF_STATICOPENGL', 'Use MESA if true', True)),
 425         ('BF_OPENGL', 'OpenGL base path', ''),
 426         ('BF_OPENGL_INC', 'OpenGL include path', ''),
 427         ('BF_OPENGL_LIB', 'OpenGL libraries', ''),
 428         ('BF_OPENGL_LIBPATH', 'OpenGL library path', ''),
 429         ('BF_OPENGL_LIB_STATIC', 'OpenGL static libraries', ''),
 430         ('BF_OPENGL_LINKFLAGS', 'OpenGL link flags', ''),
 431
 432         (BoolVariable('WITH_BF_COLLADA', 'Build COLLADA import/export module if true', False)),
 433         ('BF_COLLADA', 'COLLADA base path', ''),
 434         ('BF_COLLADA_INC', 'COLLADA include path', ''),
 435         ('BF_COLLADA_LIB', 'COLLADA library', ''),
 436         ('BF_OPENCOLLADA', 'OpenCollada base path', ''),
 437         ('BF_OPENCOLLADA_INC', 'OpenCollada base include path', ''),
 438         ('BF_OPENCOLLADA_LIB', 'OpenCollada library', ''),
 439         ('BF_OPENCOLLADA_LIBPATH', 'OpenCollada library path', ''),
 440         ('BF_PCRE', 'PCRE base path', ''),
 441         ('BF_PCRE_LIB', 'PCRE library', ''),
 442         ('BF_PCRE_LIBPATH', 'PCRE library path', ''),
 443         ('BF_EXPAT', 'Expat base path', ''),
 444         ('BF_EXPAT_LIB', 'Expat library', ''),
 445         ('BF_EXPAT_LIBPATH', 'Expat library path', ''),
 446
 447         (BoolVariable('WITH_BF_JEMALLOC', 'Use jemalloc if true', False)),
 448         (BoolVariable('WITH_BF_STATICJEMALLOC', 'Staticly link to jemalloc', False)),
 449         ('BF_JEMALLOC', 'jemalloc base path', ''),
 450         ('BF_JEMALLOC_INC', 'jemalloc include path', ''),
 451         ('BF_JEMALLOC_LIB', 'jemalloc library', ''),
 452         ('BF_JEMALLOC_LIBPATH', 'jemalloc library path', ''),
 453         ('BF_JEMALLOC_LIB_STATIC', 'jemalloc static library', ''),
 454
 455         (BoolVariable('WITH_BF_PLAYER', 'Build blenderplayer if true', False)),
 456         (BoolVariable('WITH_BF_NOBLENDER', 'Do not build blender if true', False)),
 457
 458         (BoolVariable('WITH_BF_3DMOUSE', 'Build blender with support of 3D mouses', False)),
 459         (BoolVariable('WITH_BF_STATIC3DMOUSE', 'Staticly link to 3d mouse library', False)),
 460         ('BF_3DMOUSE', '3d mouse library base path', ''),
 461         ('BF_3DMOUSE_INC', '3d mouse library include path', ''),
 462         ('BF_3DMOUSE_LIB', '3d mouse library', ''),
 463         ('BF_3DMOUSE_LIBPATH', '3d mouse library path', ''),
 464         ('BF_3DMOUSE_LIB_STATIC', '3d mouse static library', ''),
 465
 466         ('CFLAGS', 'C only flags', []),
 467         ('CCFLAGS', 'Generic C and C++ flags', []),
 468         ('CXXFLAGS', 'C++ only flags', []),
 469         ('BGE_CXXFLAGS', 'C++ only flags for BGE', []),
 470         ('CPPFLAGS', 'Defines', []),
 471         ('REL_CFLAGS', 'C only release flags', []),
 472         ('REL_CCFLAGS', 'Generic C and C++ release flags', []),
 473         ('REL_CXXFLAGS', 'C++ only release flags', []),
 474
 475         ('C_WARN', 'C warning flags', []),
 476         ('CC_WARN', 'Generic C and C++ warning flags', []),
 477         ('CXX_WARN', 'C++ only warning flags', []),
 478
 479         ('LLIBS', 'Platform libs', []),
 480         ('PLATFORM_LINKFLAGS', 'Platform linkflags', []),
 481         ('MACOSX_ARCHITECTURE', 'python_arch.zip select', ''),
 482         ('MACOSX_SDK_CHECK', 'detect available OSX sdk`s', ''),
 483         ('XCODE_CUR_VER', 'detect XCode version', ''),
 484
 485         (BoolVariable('BF_PROFILE', 'Add profiling information if true', False)),
 486         ('BF_PROFILE_CFLAGS', 'C only profiling flags', []),
 487         ('BF_PROFILE_CCFLAGS', 'C and C++ profiling flags', []),
 488         ('BF_PROFILE_CXXFLAGS', 'C++ only profiling flags', []),
 489         ('BF_PROFILE_LINKFLAGS', 'Profile linkflags', []),
 490
 491         (BoolVariable('BF_DEBUG', 'Add debug flags if true', False)),
 492         ('BF_DEBUG_CFLAGS', 'C only debug flags', []),
 493         ('BF_DEBUG_CCFLAGS', 'C and C++ debug flags', []),
 494         ('BF_DEBUG_CXXFLAGS', 'C++ only debug flags', []),
 495
 496         (BoolVariable('BF_BSC', 'Create .bsc files (msvc only)', False)),
 497
 498         ('BF_BUILDDIR', 'Build dir', ''),
 499         ('BF_INSTALLDIR', 'Installation dir', ''),
 500
 501         ('CC', 'C compiler to use', env['CC']),
 502         ('CXX', 'C++ compiler to use', env['CXX']),
 503
 504         (BoolVariable('BF_BUILDINFO', 'Buildtime in splash if true', True)),
 505
 506         (BoolVariable('BF_TWEAK_MODE', 'Enable tweak mode if true', False)),
 507         (BoolVariable('BF_SPLIT_SRC', 'Split src lib into several chunks if true', False)),
 508         (BoolVariable('WITHOUT_BF_INSTALL', 'dont install if true', False)),
 509         (BoolVariable('WITHOUT_BF_PYTHON_INSTALL', 'dont install Python modules if true', False)),
 510         (BoolVariable('WITHOUT_BF_OVERWRITE_INSTALL', 'dont remove existing files before breating the new install directory (set to False when making packages for others)', False)),
 511         (BoolVariable('BF_FANCY', 'Enable fancy output if true', True)),
 512         (BoolVariable('BF_QUIET', 'Enable silent output if true', True)),
 513         (BoolVariable('BF_LINE_OVERWRITE', 'Enable overwriting of compile line in BF_QUIET mode if true', False)),
 514         (BoolVariable('WITH_BF_BINRELOC', 'Enable relocatable binary (linux only)', False)),
 515
 516         (BoolVariable('WITH_BF_LZO', 'Enable fast LZO pointcache compression', True)),
 517         (BoolVariable('WITH_BF_LZMA', 'Enable best LZMA pointcache compression', True)),
 518
 519         (BoolVariable('WITH_BF_LIBMV', 'Enable libmv structure from motion library', True)),
 520
 521         ('BF_X264_CONFIG', 'configuration flags for x264', ''),
 522         ('BF_XVIDCORE_CONFIG', 'configuration flags for xvidcore', ''),
 523 #        (BoolVariable('WITH_BF_DOCS', 'Generate API documentation', False)),
 524
 525         ('BF_CONFIG', 'SCons python config file used to set default options', 'user_config.py'),
 526         ('BF_NUMJOBS', 'Number of build processes to spawn', '1'),
 527         ('BF_MSVS', 'Generate MSVS project files and solution', False),
 528
 529         ('BF_VERSION', 'The root path for Unix (non-apple)', '2.5'),
 530
 531         (BoolVariable('BF_UNIT_TEST', 'Build with unit test support.', False)),
 532
 533         (BoolVariable('BF_GHOST_DEBUG', 'Make GHOST print events and info to stdout. (very verbose)', False)),
 534
 535         (BoolVariable('WITH_BF_RAYOPTIMIZATION', 'Enable raytracer SSE/SIMD optimization.', False)),
 536         ('BF_RAYOPTIMIZATION_SSE_FLAGS', 'SSE flags', ''),
 537         (BoolVariable('WITH_BF_CXX_GUARDEDALLOC', 'Enable GuardedAlloc for C++ memory allocation tracking.', False)),
 538
 539         ('BUILDBOT_BRANCH', 'Buildbot branch name', ''),
 540
 541         (BoolVariable('WITH_BF_CYCLES', 'Build with the Cycles engine', True)),
 542
 543         (BoolVariable('WITH_BF_OIIO', 'Build with OpenImageIO', False)),
 544         ('BF_OIIO_INC', 'OIIO include path', ''),
 545         ('BF_OIIO_LIB', 'OIIO library', ''),
 546         ('BF_OIIO_LIBPATH', 'OIIO library path', ''),
 547
 548         (BoolVariable('WITH_BF_BOOST', 'Build with Boost', False)),
 549         ('BF_BOOST_INC', 'Boost include path', ''),
 550         ('BF_BOOST_LIB', 'Boost library', ''),
 551         ('BF_BOOST_LIBPATH', 'Boost library path', '')
 552     ) # end of opts.AddOptions()
 553
 554     return localopts
 555
 556 def buildbot_zip(src, dest, package_name, extension):
 557     import zipfile
 558     ln = len(src)+1 # one extra to remove leading os.sep when cleaning root for package_root
 559     flist = list()
 560
 561     # create list of tuples containing file and archive name
 562     for root, dirs, files in os.walk(src):
 563         package_root = os.path.join(package_name, root[ln:])
 564         flist.extend([(os.path.join(root, file), os.path.join(package_root, file)) for file in files])
 565
 566     if extension == '.zip':
 567         package = zipfile.ZipFile(dest, 'w', zipfile.ZIP_DEFLATED)
 568         package.comment = package_name + ' is a zip-file containing the Blender software. Visit http://www.blender.org for more information.'
 569         for entry in flist:
 570             package.write(entry[0], entry[1])
 571         package.close()
 572     else:
 573         import tarfile
 574         package = tarfile.open(dest, 'w:bz2')
 575         for entry in flist:
 576             package.add(entry[0], entry[1], recursive=False)
 577         package.close()
 578     bb_zip_name = os.path.normpath(src + os.sep + '..' + os.sep + 'buildbot_upload.zip')
 579     print("creating %s" % (bb_zip_name))
 580     bb_zip = zipfile.ZipFile(bb_zip_name, 'w', zipfile.ZIP_DEFLATED)
 581     print("writing %s to %s" % (dest, bb_zip_name))
 582     bb_zip.write(dest, os.path.split(dest)[1])
 583     bb_zip.close()
 584     print("removing unneeded packed file %s (to keep install directory clean)" % (dest))
 585     os.remove(dest)
 586     print("done.")
 587
 588 def buildslave_print(target, source, env):
 589     return "Running buildslave target"
 590
 591 def buildslave(target=None, source=None, env=None):
 592     """
 593     Builder for buildbot integration. Used by buildslaves of http://builder.blender.org only.
 594     """
 595
 596     if env['OURPLATFORM'] in ('win32-vc', 'win64-vc', 'win32-mingw', 'darwin'):
 597         extension = '.zip'
 598     else:
 599         extension = '.tar.bz2'
 600
 601     platform = env['OURPLATFORM'].split('-')[0]
 602     if platform == 'linux':
 603         import platform
 604
 605         bitness = platform.architecture()[0]
 606         if bitness == '64bit':
 607             platform = 'linux-glibc27-x86_64'
 608         elif bitness == '32bit':
 609             platform = 'linux-glibc27-i686'
 610     if platform == 'darwin':
 611         platform = 'OSX-' + env['MACOSX_ARCHITECTURE']
 612
 613     branch = env['BUILDBOT_BRANCH']
 614
 615     outdir = os.path.abspath(env['BF_INSTALLDIR'])
 616     package_name = 'blender-' + VERSION+'-'+REVISION + '-' + platform
 617     if branch != '':
 618         package_name = branch + '-' + package_name
 619     package_dir = os.path.normpath(outdir + os.sep + '..' + os.sep + package_name)
 620     package_archive = os.path.normpath(outdir + os.sep + '..' + os.sep + package_name + extension)
 621
 622     try:
 623         if os.path.exists(package_archive):
 624             os.remove(package_archive)
 625         if os.path.exists(package_dir):
 626             shutil.rmtree(package_dir)
 627     except Exception, ex:
 628         sys.stderr.write('Failed to clean up old package files: ' + str(ex) + '\n')
 629         return 1
 630
 631     buildbot_zip(outdir, package_archive, package_name, extension)
 632
 633     return 0
 634
 635 def NSIS_print(target, source, env):
 636     return "Creating NSIS installer for Blender"
 637
 638 def NSIS_Installer(target=None, source=None, env=None):
 639     print "="*35
 640
 641     if env['OURPLATFORM'] not in ('win32-vc', 'win32-mingw', 'win64-vc'):
 642         print "NSIS installer is only available on Windows."
 643         Exit()
 644     if env['OURPLATFORM'] == 'win32-vc':
 645         bitness = '32'
 646     elif env['OURPLATFORM'] == 'win64-vc':
 647         bitness = '64'
 648     else:
 649         bitness = '-mingw'
 650
 651     start_dir = os.getcwd()
 652     rel_dir = os.path.join(start_dir,'release','windows','installer')
 653     install_base_dir = start_dir + os.sep
 654
 655     bf_installdir = os.path.join(os.getcwd(),env['BF_INSTALLDIR'])
 656     bf_installdir = os.path.normpath(bf_installdir)
 657
 658     doneroot = False
 659     rootdirconts = []
 660     datafiles = ''
 661     deldatafiles = ''
 662     deldatadirs = ''
 663     l = len(bf_installdir)
 664
 665     for dp,dn,df in os.walk(bf_installdir):
 666         # install
 667         if not doneroot:
 668             for f in df:
 669                 rootdirconts.append(os.path.join(dp,f))
 670             doneroot = True
 671         else:
 672             if len(df)>0:
 673                 dp_tmp = dp[l:]
 674                 datafiles += "\n" +r'SetOutPath $INSTDIR'+dp[l:]+"\n\n"
 675
 676                 for f in df:
 677                     outfile = os.path.join(dp,f)
 678                     datafiles += '  File '+outfile + "\n"
 679
 680         # uninstall
 681         deldir = dp[l+1:]
 682
 683         if len(deldir)>0:
 684             deldatadirs = "RMDir $INSTDIR\\" + deldir + "\n" + deldatadirs
 685             deldatadirs = "RMDir /r $INSTDIR\\" + deldir + "\\__pycache__\n" + deldatadirs
 686
 687             for f in df:
 688                 deldatafiles += 'Delete \"$INSTDIR\\' + os.path.join(deldir, f) + "\"\n"
 689
 690     #### change to suit install dir ####
 691     inst_dir = install_base_dir + env['BF_INSTALLDIR']
 692
 693     os.chdir(rel_dir)
 694
 695     ns = open("00.sconsblender.nsi","r")
 696
 697     ns_cnt = str(ns.read())
 698     ns.close()
 699
 700     # var replacements
 701     ns_cnt = string.replace(ns_cnt, "[DISTDIR]", os.path.normpath(inst_dir+os.sep))
 702     ns_cnt = string.replace(ns_cnt, "[VERSION]", VERSION_DISPLAY)
 703     ns_cnt = string.replace(ns_cnt, "[SHORTVERSION]", VERSION)
 704     ns_cnt = string.replace(ns_cnt, "[RELDIR]", os.path.normpath(rel_dir))
 705     ns_cnt = string.replace(ns_cnt, "[BITNESS]", bitness)
 706
 707     # do root
 708     rootlist = []
 709     for rootitem in rootdirconts:
 710         rootlist.append("File \"" + rootitem + "\"")
 711     rootstring = string.join(rootlist, "\n  ")
 712     rootstring = rootstring
 713     rootstring += "\n\n"
 714     ns_cnt = string.replace(ns_cnt, "[ROOTDIRCONTS]", rootstring)
 715
 716
 717     # do delete items
 718     delrootlist = []
 719     for rootitem in rootdirconts:
 720         delrootlist.append("Delete $INSTDIR\\" + rootitem[l+1:])
 721     delrootstring = string.join(delrootlist, "\n ")
 722     delrootstring += "\n"
 723     ns_cnt = string.replace(ns_cnt, "[DELROOTDIRCONTS]", delrootstring)
 724
 725     ns_cnt = string.replace(ns_cnt, "[DODATAFILES]", datafiles)
 726     ns_cnt = string.replace(ns_cnt, "[DELDATAFILES]", deldatafiles)
 727     ns_cnt = string.replace(ns_cnt, "[DELDATADIRS]", deldatadirs)
 728
 729     tmpnsi = os.path.normpath(install_base_dir+os.sep+env['BF_BUILDDIR']+os.sep+"00.blender_tmp.nsi")
 730     new_nsis = open(tmpnsi, 'w')
 731     new_nsis.write(ns_cnt)
 732     new_nsis.close()
 733     print "NSIS Installer script created"
 734
 735     os.chdir(start_dir)
 736     print "Launching 'makensis'"
 737
 738     cmdline = "makensis " + "\""+tmpnsi+"\""
 739
 740     startupinfo = subprocess.STARTUPINFO()
 741     startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
 742     proc = subprocess.Popen(cmdline, stdin=subprocess.PIPE, stdout=subprocess.PIPE,
 743         stderr=subprocess.PIPE, startupinfo=startupinfo, shell = True)
 744     data, err = proc.communicate()
 745     rv = proc.wait()
 746
 747     if rv != 0:
 748         print
 749         print data.strip().split("\n")[-1]
 750     return rv
 751
 752 def check_environ():
 753     problematic_envvars = ""
 754     for i in os.environ:
 755         try:
 756             os.environ[i].decode('ascii')
 757         except UnicodeDecodeError:
 758             problematic_envvars = problematic_envvars + "%s = %s\n" % (i, os.environ[i])
 759     if len(problematic_envvars)>0:
 760         print("================\n\n")
 761         print("@@ ABORTING BUILD @@\n")
 762         print("PROBLEM DETECTED WITH ENVIRONMENT")
 763         print("---------------------------------\n\n")
 764         print("A problem with one or more environment variable was found")
 765         print("Their value contain non-ascii characters. Check the below")
 766         print("list and override them locally to be ASCII-clean by doing")
 767         print("'set VARNAME=cleanvalue' on the command-line prior to")
 768         print("starting the build process:\n")
 769         print(problematic_envvars)
 770         return False
 771     else:
 772         return True