3 # ***** BEGIN GPL LICENSE BLOCK *****
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.
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.
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.
19 # The Original Code is Copyright (C) 2006, Blender Foundation
20 # All rights reserved.
22 # The Original Code is: all of this file.
24 # Contributor(s): Nathan Letwory.
26 # ***** END GPL LICENSE BLOCK *****
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
39 from tempfile import mkdtemp
45 BlenderEnvironment = tools.Blender.BlenderEnvironment
50 platform = sys.platform
55 ##### BEGIN SETUP #####
57 B.possible_types = ['core', 'common', 'blender', 'intern',
58 'international', 'game', 'game2',
59 'player', 'player2', 'system']
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')
70 if not use_color=='1':
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'
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)
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)
88 ##########################
89 # setting up environment #
90 ##########################
92 # handling cmd line arguments & config file
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)
99 B.quickdebug=string.split(quickdebug, ',')
104 B.quickie=string.split(quickie,',')
108 toolset = B.arguments.get('BF_TOOLSET', None)
110 print "Using " + toolset
111 if toolset=='mstoolkit':
112 env = BlenderEnvironment(ENV = os.environ)
113 env.Tool('mstoolkit', ['tools'])
115 env = BlenderEnvironment(tools=[toolset], ENV = os.environ)
117 btools.SetupSpawn(env)
119 env = BlenderEnvironment(ENV = os.environ)
122 print "Could not create a build environment"
126 cc = B.arguments.get('CC', None)
127 cxx = B.arguments.get('CXX', None)
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'
138 env.SConscriptChdir(0)
140 crossbuild = B.arguments.get('BF_CROSS', None)
141 if crossbuild and platform!='win32':
142 platform = 'linuxcross'
144 env['OURPLATFORM'] = platform
146 configfile = 'config'+os.sep+platform+'-config.py'
148 if os.path.exists(configfile):
149 print B.bc.OKGREEN + "Using config file: " + B.bc.ENDC + configfile
151 print B.bc.FAIL + configfile + " doesn't exist" + B.bc.ENDC
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'])
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]
167 print B.bc.WARNING + userconfig + " not found, no user overrides" + B.bc.ENDC
169 opts = btools.read_opts(optfiles, B.arguments)
172 if not env['BF_FANCY']:
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')
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')
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')
193 env['CCFLAGS'].append('-fopenmp')
194 env['CPPFLAGS'].append('-fopenmp')
195 env['CXXFLAGS'].append('-fopenmp')
197 #check for additional debug libnames
199 if env.has_key('BF_DEBUG_LIBS'):
200 B.quickdebug += env['BF_DEBUG_LIBS']
202 printdebug = B.arguments.get('BF_LISTDEBUG', 0)
204 # see if this linux distro has libalut
206 if env['OURPLATFORM'] == 'linux2' :
207 if env['WITH_BF_OPENAL']:
208 mylib_test_source_file = """
210 int main(int argc, char **argv)
212 alutGetMajorVersion();
217 def CheckFreeAlut(context,env):
218 context.Message( B.bc.OKGREEN + "Linux platform detected:\n checking for FreeAlut... " + B.bc.ENDC )
220 result = context.TryLink(mylib_test_source_file, '.c')
221 context.Result(result)
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'
231 for root, dirs, files in os.walk(sconf_temp, topdown=False):
233 os.remove(os.path.join(root, name))
235 os.rmdir(os.path.join(root, name))
236 if root: os.rmdir(root)
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:
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
247 if 'blendernogame' in B.targets:
248 env['WITH_BF_GAMEENGINE'] = False
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
257 # We do a shortcut for clean when no quicklist is given: just delete
258 # builddir without reading in SConscripts
260 if 'clean' in B.targets:
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)
268 if os.path.isdir(B.root_build_dir + entry) == 1:
269 print "clean dir %s"%(B.root_build_dir+entry)
270 shutil.rmtree(B.root_build_dir+entry)
272 print "remove file %s"%(B.root_build_dir+entry)
273 os.remove(B.root_build_dir+entry)
274 for confile in ['extern/ffmpeg/config.mak', 'extern/x264/config.mak',
275 'extern/xvidcore/build/generic/platform.inc']:
276 if os.path.exists(confile):
277 print "clean file %s"%confile
279 print B.bc.OKGREEN+'...done'+B.bc.ENDC
281 print B.bc.HEADER+'Already Clean, nothing to do.'+B.bc.ENDC
284 if not os.path.isdir ( B.root_build_dir):
285 os.makedirs ( B.root_build_dir )
286 os.makedirs ( B.root_build_dir + 'source' )
287 os.makedirs ( B.root_build_dir + 'intern' )
288 os.makedirs ( B.root_build_dir + 'extern' )
289 os.makedirs ( B.root_build_dir + 'lib' )
290 os.makedirs ( B.root_build_dir + 'bin' )
292 Help(opts.GenerateHelpText(env))
294 # default is new quieter output, but if you need to see the
295 # commands, do 'scons BF_QUIET=0'
296 bf_quietoutput = B.arguments.get('BF_QUIET', '1')
298 B.set_quiet_output(env)
303 print B.bc.HEADER+'Building in '+B.bc.ENDC+B.root_build_dir
304 env.SConsignFile(B.root_build_dir+'scons-signatures')
307 ##### END SETUP ##########
311 BuildDir(B.root_build_dir+'/intern', 'intern', duplicate=0)
312 SConscript(B.root_build_dir+'/intern/SConscript')
313 BuildDir(B.root_build_dir+'/extern', 'extern', duplicate=0)
314 SConscript(B.root_build_dir+'/extern/SConscript')
315 BuildDir(B.root_build_dir+'/source', 'source', duplicate=0)
316 SConscript(B.root_build_dir+'/source/SConscript')
318 # now that we have read all SConscripts, we know what
319 # libraries will be built. Create list of
320 # libraries to give as objects to linking phase
322 for tp in B.possible_types:
323 if not tp == 'player' and not tp == 'player2':
324 mainlist += B.create_blender_liblist(env, tp)
326 if B.arguments.get('BF_PRIORITYLIST', '0')=='1':
327 B.propose_priorities()
329 dobj = B.buildinfo(env, "dynamic") + B.resources
330 thestatlibs, thelibincs = B.setup_staticlibs(env)
331 thesyslibs = B.setup_syslibs(env)
333 env.BlenderProg(B.root_build_dir, "blender", dobj + mainlist + thestatlibs, [], thesyslibs, [B.root_build_dir+'/lib'] + thelibincs, 'blender')
334 if env['WITH_BF_PLAYER']:
335 playerlist = B.create_blender_liblist(env, 'player')
336 env.BlenderProg(B.root_build_dir, "blenderplayer", dobj + playerlist + thestatlibs, [], thesyslibs, [B.root_build_dir+'/lib'] + thelibincs, 'blenderplayer')
338 ##### Now define some targets
341 #------------ INSTALL
345 if env['OURPLATFORM']=='darwin':
346 for prg in B.program_list:
347 bundle = '%s.app' % prg[0]
348 bundledir = os.path.dirname(bundle)
349 for dp, dn, df in os.walk(bundle):
354 dir=env['BF_INSTALLDIR']+dp[len(bundledir):]
355 source=[dp+os.sep+f for f in df]
356 blenderinstall.append(env.Install(dir=dir,source=source))
358 blenderinstall = env.Install(dir=env['BF_INSTALLDIR'], source=B.program_list)
361 #- dont do .blender and scripts for darwin, it is already in the bundle
366 if env['OURPLATFORM']!='darwin':
367 for dp, dn, df in os.walk('bin/.blender'):
373 dotblendlist.append(dp+os.sep+f)
374 dottargetlist.append(env['BF_INSTALLDIR']+dp[3:]+os.sep+f)
376 dotblenderinstall = []
377 for targetdir,srcfile in zip(dottargetlist, dotblendlist):
378 td, tf = os.path.split(targetdir)
379 dotblenderinstall.append(env.Install(dir=td, source=srcfile))
382 scriptpath='release/scripts'
383 for dp, dn, df in os.walk(scriptpath):
388 dir=env['BF_INSTALLDIR']+'/.blender/scripts'+dp[len(scriptpath):]
389 source=[dp+os.sep+f for f in df]
390 scriptinstall.append(env.Install(dir=dir,source=source))
395 for tp, tn, tf in os.walk('release/plugins'):
401 print ">>>", env['BF_INSTALLDIR'], tp, f
402 pluglist.append(tp+os.sep+f)
403 plugtargetlist.append(env['BF_INSTALLDIR']+tp[7:]+os.sep+f)
405 # header files for plugins
406 pluglist.append('source/blender/blenpluginapi/documentation.h')
407 plugtargetlist.append(env['BF_INSTALLDIR'] + os.sep + 'plugins' + os.sep + 'include' + os.sep +'documentation.h')
408 pluglist.append('source/blender/blenpluginapi/externdef.h')
409 plugtargetlist.append(env['BF_INSTALLDIR'] + os.sep + 'plugins' + os.sep + 'include' + os.sep +'externdef.h')
410 pluglist.append('source/blender/blenpluginapi/floatpatch.h')
411 plugtargetlist.append(env['BF_INSTALLDIR'] + os.sep + 'plugins' + os.sep + 'include' + os.sep +'floatpatch.h')
412 pluglist.append('source/blender/blenpluginapi/iff.h')
413 plugtargetlist.append(env['BF_INSTALLDIR'] + os.sep + 'plugins' + os.sep + 'include' + os.sep +'iff.h')
414 pluglist.append('source/blender/blenpluginapi/plugin.h')
415 plugtargetlist.append(env['BF_INSTALLDIR'] + os.sep + 'plugins' + os.sep + 'include' + os.sep +'plugin.h')
416 pluglist.append('source/blender/blenpluginapi/util.h')
417 plugtargetlist.append(env['BF_INSTALLDIR'] + os.sep + 'plugins' + os.sep + 'include' + os.sep +'util.h')
418 pluglist.append('source/blender/blenpluginapi/plugin.def')
419 plugtargetlist.append(env['BF_INSTALLDIR'] + os.sep + 'plugins' + os.sep + 'include' + os.sep + 'plugin.def')
422 for targetdir,srcfile in zip(plugtargetlist, pluglist):
423 td, tf = os.path.split(targetdir)
424 plugininstall.append(env.Install(dir=td, source=srcfile))
428 for tp, tn, tf in os.walk('release/text'):
434 textlist.append(tp+os.sep+f)
436 textinstall = env.Install(dir=env['BF_INSTALLDIR'], source=textlist)
438 if env['OURPLATFORM']=='darwin':
439 allinstall = [blenderinstall, plugininstall, textinstall]
441 allinstall = [blenderinstall, dotblenderinstall, scriptinstall, plugininstall, textinstall]
443 if env['OURPLATFORM'] in ('win32-vc', 'win32-mingw'):
444 dllsources = ['${LCGDIR}/gettext/lib/gnu_gettext.dll',
445 '${LCGDIR}/png/lib/libpng.dll',
446 '#release/windows/extra/python25.zip',
447 '#release/windows/extra/zlib.pyd',
448 '${LCGDIR}/sdl/lib/SDL.dll',
449 '${LCGDIR}/zlib/lib/zlib.dll',
450 '${LCGDIR}/tiff/lib/libtiff.dll']
452 dllsources.append('${LCGDIR}/python/lib/${BF_PYTHON_LIB}_d.dll')
454 dllsources.append('${LCGDIR}/python/lib/${BF_PYTHON_LIB}.dll')
455 if env['OURPLATFORM'] == 'win32-mingw':
456 dllsources += ['${LCGDIR}/pthreads/lib/pthreadGC2.dll']
458 dllsources += ['${LCGDIR}/pthreads/lib/pthreadVC2.dll']
459 if env['WITH_BF_ICONV']:
460 dllsources += ['${LCGDIR}/iconv/lib/iconv.dll']
461 if env['WITH_BF_FFMPEG']:
462 dllsources += ['${LCGDIR}/ffmpeg/lib/avcodec-51.dll',
463 '${LCGDIR}/ffmpeg/lib/avformat-52.dll',
464 '${LCGDIR}/ffmpeg/lib/avdevice-52.dll',
465 '${LCGDIR}/ffmpeg/lib/avutil-49.dll',
466 '${LCGDIR}/ffmpeg/lib/libfaad-0.dll',
467 '${LCGDIR}/ffmpeg/lib/libfaac-0.dll',
468 '${LCGDIR}/ffmpeg/lib/libmp3lame-0.dll',
469 '${LCGDIR}/ffmpeg/lib/libx264-59.dll',
470 '${LCGDIR}/ffmpeg/lib/xvidcore.dll',
471 '${LCGDIR}/ffmpeg/lib/swscale-0.dll']
472 windlls = env.Install(dir=env['BF_INSTALLDIR'], source = dllsources)
473 allinstall += windlls
475 installtarget = env.Alias('install', allinstall)
476 bininstalltarget = env.Alias('install-bin', blenderinstall)
478 nsisaction = env.Action(btools.NSIS_Installer, btools.NSIS_print)
479 nsiscmd = env.Command('nsisinstaller', None, nsisaction)
480 nsisalias = env.Alias('nsis', nsiscmd)
482 if env['WITH_BF_PLAYER']:
483 blenderplayer = env.Alias('blenderplayer', B.program_list)
484 Depends(blenderplayer,installtarget)
486 if not env['WITH_BF_GAMEENGINE']:
487 blendernogame = env.Alias('blendernogame', B.program_list)
488 Depends(blendernogame,installtarget)
490 Depends(nsiscmd, allinstall)
492 Default(B.program_list)
494 if not env['WITHOUT_BF_INSTALL']:
495 Default(installtarget)
497 #------------ RELEASE
498 # TODO: zipup the installation
500 #------------ BLENDERPLAYER
501 # TODO: build stubs and link into blenderplayer