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