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