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