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