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