Merged changes from trunk to soc-2008-mxcurioni: svn merge -r 14534:14595 https:...
[blender-staging.git] / SConstruct
1 #!/usr/bin/env python
2 # $Id$
3 # ***** BEGIN GPL LICENSE BLOCK *****
4 #
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software Foundation,
17 # Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18 #
19 # The Original Code is Copyright (C) 2006, Blender Foundation
20 # All rights reserved.
21 #
22 # The Original Code is: all of this file.
23 #
24 # Contributor(s): Nathan Letwory.
25 #
26 # ***** END GPL LICENSE BLOCK *****
27 #
28 # Main entry-point for the SCons building system
29 # Set up some custom actions and target/argument handling
30 # Then read all SConscripts and build
31
32 import sys
33 import os
34 import os.path
35 import string
36 import shutil
37 import glob
38 import re
39 from tempfile import mkdtemp
40
41 import tools.Blender
42 import tools.btools
43 import tools.bcolors
44
45 BlenderEnvironment = tools.Blender.BlenderEnvironment
46 btools = tools.btools
47 B = tools.Blender
48
49 ### globals ###
50 platform = sys.platform
51 quickie = None
52 quickdebug = None
53 nsis_build = None
54
55 ##### BEGIN SETUP #####
56
57 B.possible_types = ['core', 'common', 'blender', 'intern',
58                     'international', 'game', 'game2',
59                     'player', 'player2', 'system']
60
61 B.binarykind = ['blender' , 'blenderplayer']
62 ##################################
63 # target and argument validation #
64 ##################################
65 # XX cheating for BF_FANCY, we check for BF_FANCY before args are validated
66 use_color = ARGUMENTS.get('BF_FANCY', '1')
67 if platform=='win32':
68     use_color = None
69
70 if not use_color=='1':
71     B.bc.disable()
72     
73  #on defaut white Os X terminal, some colors are totally unlegible
74 if platform=='darwin':
75     B.bc.OKGREEN = '\033[34m'
76     B.bc.WARNING = '\033[36m'
77
78 # arguments
79 print B.bc.HEADER+'Command-line arguments'+B.bc.ENDC
80 B.arguments = btools.validate_arguments(ARGUMENTS, B.bc)
81 btools.print_arguments(B.arguments, B.bc)
82
83 # targets
84 print B.bc.HEADER+'Command-line targets'+B.bc.ENDC
85 B.targets = btools.validate_targets(COMMAND_LINE_TARGETS, B.bc)
86 btools.print_targets(B.targets, B.bc)
87
88 ##########################
89 # setting up environment #
90 ##########################
91
92 # handling cmd line arguments & config file
93
94 # first check cmdline for toolset and we create env to work on
95 quickie = B.arguments.get('BF_QUICK', None)
96 quickdebug = B.arguments.get('BF_QUICKDEBUG', None)
97
98 if quickdebug:
99     B.quickdebug=string.split(quickdebug, ',')
100 else:
101     B.quickdebug=[]
102
103 if quickie:
104     B.quickie=string.split(quickie,',')
105 else:
106     B.quickie=[]
107     
108 toolset = B.arguments.get('BF_TOOLSET', None)
109 if toolset:
110     print "Using " + toolset
111     if toolset=='mstoolkit':
112         env = BlenderEnvironment(ENV = os.environ)
113         env.Tool('mstoolkit', ['tools'])
114     else:
115         env = BlenderEnvironment(tools=[toolset], ENV = os.environ)
116         if env:
117             btools.SetupSpawn(env)
118 else:
119     env = BlenderEnvironment(ENV = os.environ)
120
121 if not env:
122     print "Could not create a build environment"
123     Exit()
124
125
126 cc = B.arguments.get('CC', None)
127 cxx = B.arguments.get('CXX', None)
128 if cc:
129     env['CC'] = cc
130 if cxx:
131     env['CXX'] = cxx
132
133 if env['CC'] in ['cl', 'cl.exe'] and sys.platform=='win32':
134     platform = 'win32-vc'
135 elif env['CC'] in ['gcc'] and sys.platform=='win32':
136     platform = 'win32-mingw'
137
138 env.SConscriptChdir(0)
139
140 crossbuild = B.arguments.get('BF_CROSS', None)
141 if crossbuild and platform!='win32':
142     platform = 'linuxcross'
143
144 env['OURPLATFORM'] = platform
145
146 configfile = 'config'+os.sep+platform+'-config.py'
147
148 if os.path.exists(configfile):
149     print B.bc.OKGREEN + "Using config file: " + B.bc.ENDC + configfile
150 else:
151     print B.bc.FAIL + configfile + " doesn't exist" + B.bc.ENDC
152
153 if crossbuild and env['PLATFORM'] != 'win32':
154     print B.bc.HEADER+"Preparing for crossbuild"+B.bc.ENDC
155     env.Tool('crossmingw', ['tools'])
156     # todo: determine proper libs/includes etc.
157     # Needed for gui programs, console programs should do without it
158     env.Append(LINKFLAGS=['-mwindows'])
159
160 userconfig = B.arguments.get('BF_CONFIG', 'user-config.py')
161 # first read platform config. B.arguments will override
162 optfiles = [configfile]
163 if os.path.exists(userconfig):
164     print B.bc.OKGREEN + "Using user-config file: " + B.bc.ENDC + userconfig
165     optfiles += [userconfig]
166 else:
167     print B.bc.WARNING + userconfig + " not found, no user overrides" + B.bc.ENDC
168
169 opts = btools.read_opts(optfiles, B.arguments)
170 opts.Update(env)
171
172 if not env['BF_FANCY']:
173     B.bc.disable()
174
175 # disable elbeem (fluidsim) compilation?
176 if env['BF_NO_ELBEEM'] == 1:
177     env['CPPFLAGS'].append('-DDISABLE_ELBEEM')
178     env['CXXFLAGS'].append('-DDISABLE_ELBEEM')
179     env['CCFLAGS'].append('-DDISABLE_ELBEEM')
180
181 if env['WITH_BF_OPENMP'] == 1:
182         if env['OURPLATFORM']=='win32-vc':
183                 env['CCFLAGS'].append('/openmp')
184                 env['CPPFLAGS'].append('/openmp')
185                 env['CXXFLAGS'].append('/openmp')
186         else:
187             if env['CC'] == 'icc':
188                 env.Append(LINKFLAGS=['-openmp', '-static-intel'])
189                 env['CCFLAGS'].append('-openmp')
190                 env['CPPFLAGS'].append('-openmp')
191                 env['CXXFLAGS'].append('-openmp')
192             else:
193                 env['CCFLAGS'].append('-fopenmp')
194                 env['CPPFLAGS'].append('-fopenmp')
195                 env['CXXFLAGS'].append('-fopenmp')
196
197 #check for additional debug libnames
198
199 if env.has_key('BF_DEBUG_LIBS'):
200     B.quickdebug += env['BF_DEBUG_LIBS']
201
202 printdebug = B.arguments.get('BF_LISTDEBUG', 0)
203
204 # see if this linux distro has libalut
205
206 if env['OURPLATFORM'] == 'linux2' :
207     if env['WITH_BF_OPENAL']:
208         mylib_test_source_file = """
209         #include "AL/alut.h"
210         int main(int argc, char **argv)
211         {
212             alutGetMajorVersion();
213             return 0;
214         }
215         """
216
217         def CheckFreeAlut(context,env):
218             context.Message( B.bc.OKGREEN + "Linux platform detected:\n  checking for FreeAlut... " + B.bc.ENDC )
219             env['LIBS'] = 'alut'
220             result = context.TryLink(mylib_test_source_file, '.c')
221             context.Result(result)
222             return result
223
224         env2 = env.Copy( LIBPATH = env['BF_OPENAL'] ) 
225         sconf_temp = mkdtemp()
226         conf = Configure( env2, {'CheckFreeAlut' : CheckFreeAlut}, sconf_temp, '/dev/null' )
227         if conf.CheckFreeAlut( env2 ):
228             env['BF_OPENAL_LIB'] += ' alut'
229         del env2
230         root = ''
231         for root, dirs, files in os.walk(sconf_temp, topdown=False):
232             for name in files:
233                 os.remove(os.path.join(root, name))
234             for name in dirs:
235                 os.rmdir(os.path.join(root, name))
236         if root: os.rmdir(root)
237
238 if len(B.quickdebug) > 0 and printdebug != 0:
239     print B.bc.OKGREEN + "Buildings these libs with debug symbols:" + B.bc.ENDC
240     for l in B.quickdebug:
241         print "\t" + l
242
243 # check target for blenderplayer. Set WITH_BF_PLAYER if found on cmdline
244 if 'blenderplayer' in B.targets:
245     env['WITH_BF_PLAYER'] = True
246
247 if 'blendernogame' in B.targets:
248     env['WITH_BF_GAMEENGINE'] = False
249
250 # lastly we check for root_build_dir ( we should not do before, otherwise we might do wrong builddir
251 #B.root_build_dir = B.arguments.get('BF_BUILDDIR', '..'+os.sep+'build'+os.sep+platform+os.sep)
252 B.root_build_dir = env['BF_BUILDDIR']
253 env['BUILDDIR'] = B.root_build_dir
254 if not B.root_build_dir[-1]==os.sep:
255     B.root_build_dir += os.sep
256     
257 # We do a shortcut for clean when no quicklist is given: just delete
258 # builddir without reading in SConscripts
259 do_clean = None
260 if 'clean' in B.targets:
261     do_clean = True
262
263 if not quickie and do_clean:
264     if os.path.exists(B.root_build_dir):
265         print B.bc.HEADER+'Cleaning...'+B.bc.ENDC
266         dirs = os.listdir(B.root_build_dir)
267         for dir in dirs:
268             if os.path.isdir(B.root_build_dir + dir) == 1:
269                 print "clean dir %s"%(B.root_build_dir+dir)
270                 shutil.rmtree(B.root_build_dir+dir)
271         for confile in ['extern/ffmpeg/config.mak', 'extern/x264/config.mak',
272                 'extern/xvidcore/build/generic/platform.inc']:
273             if os.path.exists(confile):
274                 print "clean file %s"%confile
275                 os.remove(confile)
276         print B.bc.OKGREEN+'...done'+B.bc.ENDC
277     else:
278         print B.bc.HEADER+'Already Clean, nothing to do.'+B.bc.ENDC
279     Exit()
280
281 if not os.path.isdir ( B.root_build_dir):
282     os.makedirs ( B.root_build_dir )
283     os.makedirs ( B.root_build_dir + 'source' )
284     os.makedirs ( B.root_build_dir + 'intern' )
285     os.makedirs ( B.root_build_dir + 'extern' )
286     os.makedirs ( B.root_build_dir + 'lib' )
287     os.makedirs ( B.root_build_dir + 'bin' )
288
289 Help(opts.GenerateHelpText(env))
290
291 # default is new quieter output, but if you need to see the 
292 # commands, do 'scons BF_QUIET=0'
293 bf_quietoutput = B.arguments.get('BF_QUIET', '1')
294 if env['BF_QUIET']:
295     B.set_quiet_output(env)
296 else:
297     if toolset=='msvc':
298         B.msvc_hack(env)
299
300 print B.bc.HEADER+'Building in '+B.bc.ENDC+B.root_build_dir
301 env.SConsignFile(B.root_build_dir+'scons-signatures')
302 B.init_lib_dict()
303
304 ##### END SETUP ##########
305
306 Export('env')
307
308 BuildDir(B.root_build_dir+'/intern', 'intern', duplicate=0)
309 SConscript(B.root_build_dir+'/intern/SConscript')
310 BuildDir(B.root_build_dir+'/extern', 'extern', duplicate=0)
311 SConscript(B.root_build_dir+'/extern/SConscript')
312 BuildDir(B.root_build_dir+'/source', 'source', duplicate=0)
313 SConscript(B.root_build_dir+'/source/SConscript')
314
315 # now that we have read all SConscripts, we know what
316 # libraries will be built. Create list of
317 # libraries to give as objects to linking phase
318 mainlist = []
319 for tp in B.possible_types:
320     if not tp == 'player' and not tp == 'player2':
321         mainlist += B.create_blender_liblist(env, tp)
322
323 if B.arguments.get('BF_PRIORITYLIST', '0')=='1':
324     B.propose_priorities()
325
326 dobj = B.buildinfo(env, "dynamic") + B.resources
327 thestatlibs, thelibincs = B.setup_staticlibs(env)
328 thesyslibs = B.setup_syslibs(env)
329
330 env.BlenderProg(B.root_build_dir, "blender", dobj + mainlist + thestatlibs, [], thesyslibs, [B.root_build_dir+'/lib'] + thelibincs, 'blender')
331 if env['WITH_BF_PLAYER']:
332     playerlist = B.create_blender_liblist(env, 'player')
333     env.BlenderProg(B.root_build_dir, "blenderplayer", dobj + playerlist + thestatlibs, [], thesyslibs, [B.root_build_dir+'/lib'] + thelibincs, 'blenderplayer')
334
335 ##### Now define some targets
336
337
338 #------------ INSTALL
339
340 #-- binaries
341 blenderinstall = []
342 if  env['OURPLATFORM']=='darwin':
343     for prg in B.program_list:
344         bundle = '%s.app' % prg[0]
345         bundledir = os.path.dirname(bundle)
346         for dp, dn, df in os.walk(bundle):
347             if 'CVS' in dn:
348                 dn.remove('CVS')
349             if '.svn' in dn:
350                 dn.remove('.svn')
351             dir=env['BF_INSTALLDIR']+dp[len(bundledir):]
352             source=[dp+os.sep+f for f in df]
353             blenderinstall.append(env.Install(dir=dir,source=source))
354 else:
355     blenderinstall = env.Install(dir=env['BF_INSTALLDIR'], source=B.program_list)
356
357 #-- .blender
358 #- dont do .blender and scripts for darwin, it is already in the bundle
359 dotblendlist = []
360 dottargetlist = []
361 scriptinstall = []
362
363 if  env['OURPLATFORM']!='darwin':
364         for dp, dn, df in os.walk('bin/.blender'):
365             if 'CVS' in dn:
366                 dn.remove('CVS')
367             if '.svn' in dn:
368                 dn.remove('.svn')
369             for f in df:
370                 dotblendlist.append(dp+os.sep+f)
371                 dottargetlist.append(env['BF_INSTALLDIR']+dp[3:]+os.sep+f)
372
373         dotblenderinstall = []
374         for targetdir,srcfile in zip(dottargetlist, dotblendlist):
375             td, tf = os.path.split(targetdir)
376             dotblenderinstall.append(env.Install(dir=td, source=srcfile))
377         
378         #-- .blender/scripts    
379         scriptpath='release/scripts'
380         for dp, dn, df in os.walk(scriptpath):
381             if 'CVS' in dn:
382                 dn.remove('CVS')
383             if '.svn' in dn:
384                 dn.remove('.svn')
385             dir=env['BF_INSTALLDIR']+'/.blender/scripts'+dp[len(scriptpath):]
386             source=[dp+os.sep+f for f in df]
387             scriptinstall.append(env.Install(dir=dir,source=source))
388
389 #-- plugins
390 pluglist = []
391 plugtargetlist = []
392 for tp, tn, tf in os.walk('release/plugins'):
393     if 'CVS' in tn:
394         tn.remove('CVS')
395     if '.svn' in tn:
396         tn.remove('.svn')
397     for f in tf:
398         pluglist.append(tp+os.sep+f)
399         plugtargetlist.append(env['BF_INSTALLDIR']+tp[7:]+os.sep+f)
400
401 plugininstall = []
402 for targetdir,srcfile in zip(plugtargetlist, pluglist):
403     td, tf = os.path.split(targetdir)
404     plugininstall.append(env.Install(dir=td, source=srcfile))
405
406 textlist = []
407 texttargetlist = []
408 for tp, tn, tf in os.walk('release/text'):
409     if 'CVS' in tn:
410         tn.remove('CVS')
411     if '.svn' in tn:
412         tn.remove('.svn')
413     for f in tf:
414         textlist.append(tp+os.sep+f)
415
416 textinstall = env.Install(dir=env['BF_INSTALLDIR'], source=textlist)
417
418 if  env['OURPLATFORM']=='darwin':
419         allinstall = [blenderinstall, plugininstall, textinstall]
420 else:
421         allinstall = [blenderinstall, dotblenderinstall, scriptinstall, plugininstall, textinstall]
422
423 if env['OURPLATFORM'] in ('win32-vc', 'win32-mingw'):
424     dllsources = ['${LCGDIR}/gettext/lib/gnu_gettext.dll',
425                         '${LCGDIR}/png/lib/libpng.dll',
426                         '#release/windows/extra/python25.zip',
427                         '#release/windows/extra/zlib.pyd',
428                         '${LCGDIR}/sdl/lib/SDL.dll',
429                         '${LCGDIR}/zlib/lib/zlib.dll',
430                         '${LCGDIR}/tiff/lib/libtiff.dll']
431     if env['BF_DEBUG']:
432         dllsources.append('${LCGDIR}/python/lib/${BF_PYTHON_LIB}_d.dll')
433     else:
434         dllsources.append('${LCGDIR}/python/lib/${BF_PYTHON_LIB}.dll')
435     if env['OURPLATFORM'] == 'win32-mingw':
436         dllsources += ['${LCGDIR}/pthreads/lib/pthreadGC2.dll']
437     else:
438         dllsources += ['${LCGDIR}/pthreads/lib/pthreadVC2.dll']
439     if env['WITH_BF_ICONV']:
440         dllsources += ['${LCGDIR}/iconv/lib/iconv.dll']
441     if env['WITH_BF_FFMPEG']:
442         dllsources += ['${LCGDIR}/ffmpeg/lib/avcodec-51.dll',
443                         '${LCGDIR}/ffmpeg/lib/avformat-52.dll',
444                         '${LCGDIR}/ffmpeg/lib/avdevice-52.dll',
445                         '${LCGDIR}/ffmpeg/lib/avutil-49.dll',
446                         '${LCGDIR}/ffmpeg/lib/libfaad-0.dll',
447                         '${LCGDIR}/ffmpeg/lib/libfaac-0.dll',
448                         '${LCGDIR}/ffmpeg/lib/libmp3lame-0.dll',
449                         '${LCGDIR}/ffmpeg/lib/libx264-59.dll',
450                         '${LCGDIR}/ffmpeg/lib/xvidcore.dll',
451                         '${LCGDIR}/ffmpeg/lib/swscale-0.dll']
452     windlls = env.Install(dir=env['BF_INSTALLDIR'], source = dllsources)
453     allinstall += windlls
454
455 installtarget = env.Alias('install', allinstall)
456 bininstalltarget = env.Alias('install-bin', blenderinstall)
457
458 nsisaction = env.Action(btools.NSIS_Installer, btools.NSIS_print)
459 nsiscmd = env.Command('nsisinstaller', None, nsisaction)
460 nsisalias = env.Alias('nsis', nsiscmd)
461
462 if env['WITH_BF_PLAYER']:
463     blenderplayer = env.Alias('blenderplayer', B.program_list)
464     Depends(blenderplayer,installtarget)
465
466 if not env['WITH_BF_GAMEENGINE']:
467     blendernogame = env.Alias('blendernogame', B.program_list)
468     Depends(blendernogame,installtarget)
469
470 Depends(nsiscmd, allinstall)
471
472 Default(B.program_list)
473
474 if not env['WITHOUT_BF_INSTALL']:
475         Default(installtarget)
476
477 #------------ RELEASE
478 # TODO: zipup the installation
479
480 #------------ BLENDERPLAYER
481 # TODO: build stubs and link into blenderplayer
482
483 #------------ EPYDOC
484 # TODO: run epydoc
485