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