=== SCons ===
[blender.git] / tools / btools.py
1 import os
2 import os.path
3 import SCons.Options
4 import SCons.Options.BoolOption
5 import subprocess
6 import string
7
8 Options = SCons.Options
9 BoolOption = SCons.Options.BoolOption
10
11 def print_arguments(args, bc):
12     if len(args):
13         for k,v in args.iteritems():
14             print '\t'+bc.OKBLUE+k+bc.ENDC+' = '+bc.OKGREEN + v + bc.ENDC
15     else:
16         print '\t'+bc.WARNING+'No  command-line arguments given'+bc.ENDC
17
18 def validate_arguments(args, bc):
19     opts_list = [
20             'BF_PYTHON', 'BF_PYTHON_VERSION', 'BF_PYTHON_INC', 'BF_PYTHON_BINARY', 'BF_PYTHON_LIB', 'BF_PYTHON_LIBPATH', 'BF_PYTHON_LINKFLAGS',
21             'WITH_BF_OPENAL', 'BF_OPENAL', 'BF_OPENAL_INC', 'BF_OPENAL_LIB', 'BF_OPENAL_LIBPATH',
22             'WITH_BF_SDL', 'BF_SDL', 'BF_SDL_INC', 'BF_SDL_LIB', 'BF_SDL_LIBPATH',
23             'BF_PTHREADS', 'BF_PTHREADS_INC', 'BF_PTHREADS_LIB', 'BF_PTHREADS_LIBPATH',
24             'WITH_BF_FMOD',
25             'WITH_BF_OPENEXR', 'BF_OPENEXR', 'BF_OPENEXR_INC', 'BF_OPENEXR_LIB', 'BF_OPENEXR_LIBPATH',
26             'WITH_BF_FFMPEG', 'BF_FFMPEG_LIB', 'BF_FFMPEG',  'BF_FFMPEG_INC',
27             'WITH_BF_JPEG', 'BF_JPEG', 'BF_JPEG_INC', 'BF_JPEG_LIB', 'BF_JPEG_LIBPATH',
28             'WITH_BF_PNG', 'BF_PNG', 'BF_PNG_INC', 'BF_PNG_LIB', 'BF_PNG_LIBPATH',
29             'BF_TIFF', 'BF_TIFF_INC',
30             'WITH_BF_ZLIB', 'BF_ZLIB', 'BF_ZLIB_INC', 'BF_ZLIB_LIB', 'BF_ZLIB_LIBPATH',
31             'WITH_BF_INTERNATIONAL',
32             'BF_GETTEXT', 'BF_GETTEXT_INC', 'BF_GETTEXT_LIB', 'BF_GETTEXT_LIBPATH',
33             'WITH_BF_ICONV', 'BF_ICONV', 'BF_ICONV_INC', 'BF_ICONV_LIB', 'BF_ICONV_LIBPATH',
34             'WITH_BF_ODE', 'BF_ODE', 'BF_ODE_INC', 'BF_ODE_LIB',
35             'WITH_BF_GAMEENGINE', 'WITH_BF_BULLET', 'BF_BULLET', 'BF_BULLET_INC', 'BF_BULLET_LIB',
36             'BF_SOLID', 'BF_SOLID_INC', 'BF_WINTAB', 'BF_WINTAB_INC',
37             'WITH_BF_YAFRAY',
38             'BF_FREETYPE', 'BF_FREETYPE_INC', 'BF_FREETYPE_LIB', 'BF_FREETYPE_LIBPATH',
39             'WITH_BF_QUICKTIME', 'BF_QUICKTIME', 'BF_QUICKTIME_INC', 'BF_QUICKTIME_LIB', 'BF_QUICKTIME_LIBPATH',
40             'WITH_BF_STATICOPENGL', 'BF_OPENGL', 'BF_OPENGL_INC', 'BF_OPENGL_LIB', 'BF_OPENGL_LIBPATH', 'BF_OPENGL_LIB_STATIC', 'BF_OPENGL_LINKFLAGS',
41             'WITH_BF_FTGL', 'BF_FTGL', 'BF_FTGL_INC', 'BF_FTGL_LIB',
42             'WITH_BF_FFMPEG',
43             'WITH_BF_PLAYER',
44             'CFLAGS', 'CCFLAGS', 'CPPFLAGS', 
45             'REL_CFLAGS', 'REL_CCFLAGS',
46             'C_WARN', 'CC_WARN', 'LLIBS', 'PLATFORM_LINKFLAGS',
47             'BF_PROFILE_FLAGS', 'LCGDIR', 'WITH_BF_VERSE', 
48             'BF_VERSE_INCLUDE',
49             'VERSE_BUILD_BINARY', 'VERSE_BUILD_DIR', 'VERSE_REGEN_PROTO',
50             'BF_TWEAK_MODE'
51             ]
52
53     arg_list = ['BF_DEBUG', 'BF_QUIET', 'BF_CROSS', 'BF_UPDATE',
54             'BF_INSTALLDIR', 'BF_TOOLSET', 'BF_BINNAME',
55             'BF_BUILDDIR', 'BF_FANCY', 'BF_QUICK', 'BF_PROFILE',
56             'BF_DEBUG_FLAGS', 'BF_BSC',
57             'BF_PRIORITYLIST', 'BF_BUILDINFO','CC', 'CXX', "BF_QUICKDEBUG", "BF_LISTDEBUG", 'LCGDIR']
58
59     all_list = opts_list + arg_list
60     okdict = {}
61
62     for k,v in args.iteritems():
63         if k in all_list:
64             okdict[k] = v
65         else:
66             print '\t'+bc.WARNING+'Invalid argument: '+bc.ENDC+k+'='+v
67
68     return okdict
69
70 def print_targets(targs, bc):
71     if len(targs)>0:
72         for t in targs:
73             print '\t'+bc.OKBLUE+t+bc.ENDC
74     else:
75         print '\t'+bc.WARNING+'No targets given, using '+bc.ENDC+bc.OKGREEN+'default'+bc.ENDC
76
77 def validate_targets(targs, bc):
78     valid_list = ['.', 'blender', 'blenderstatic', 'blenderplayer', 'webplugin',
79             'blendernogame', 'blenderstaticnogame', 'release',
80             'everything', 'clean', 'install-bin', 'install', 'nsis']
81     oklist = []
82     for t in targs:
83         if t in valid_list:
84             oklist.append(t)
85         else:
86             print '\t'+bc.WARNING+'Invalid target: '+bc.ENDC+t
87     return oklist
88
89 class ourSpawn:
90     def ourspawn(self, sh, escape, cmd, args, env):
91         newargs = string.join(args[1:], ' ')
92         cmdline = cmd + " " + newargs
93         startupinfo = subprocess.STARTUPINFO()
94         startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
95         proc = subprocess.Popen(cmdline, stdin=subprocess.PIPE, stdout=subprocess.PIPE,
96             stderr=subprocess.PIPE, startupinfo=startupinfo, shell = False)
97         data, err = proc.communicate()
98         rv = proc.wait()
99         if rv:
100             print "====="
101             print err
102             print "====="
103         return rv
104
105 def SetupSpawn( env ):
106     buf = ourSpawn()
107     buf.ourenv = env
108     env['SPAWN'] = buf.ourspawn
109
110
111 def read_opts(cfg, args):
112     localopts = Options.Options(cfg, args)
113     localopts.AddOptions(
114         ('VERSE_BUILD_BINARY', 'Build a release or debug binary.', 'release'),
115         ('VERSE_BUILD_DIR', 'Target directory for intermediate files.', "${BF_BUILDDIR}/extern/verse"),
116         ('VERSE_REGEN_PROTO', 'Whether to regenerate the protocol files', 'yes'),
117         (BoolOption('WITH_BF_VERSE', 'Use VERSE if true', 'false')),
118         ('BF_VERSE_INCLUDE', 'verse include dir', '/usr/include'),
119         ('LCGDIR', 'location of cvs lib dir'),
120         ('VERSE_BUILD_BINARY', 'Build a release or debug binary.', 'release'),
121         ('VERSE_BUILD_DIR', 'Target directory for intermediate files.', "${BF_BUILDDIR}/extern/verse"),
122         ('VERSE_REGEN_PROTO', 'Whether to regenerate the protocol files', 'yes'),
123         ('BF_DEBUG_LIBS', 'list of libraries to build with debug symbols'),
124         ('BF_PYTHON', 'base path for python', ''),
125         ('BF_PYTHON_VERSION', 'Python version to use', ''),
126         ('BF_PYTHON_INC', 'include path for Python headers', ''),
127         ('BF_PYTHON_BINARY', 'Path to the Python interpreter', ''),
128         ('BF_PYTHON_LIB', 'Python library', ''),
129         ('BF_PYTHON_LIBPATH', 'Library path', ''),
130         ('BF_PYTHON_LINKFLAGS', 'Python link flags', ''),
131         (BoolOption('BF_NO_ELBEEM', 'Disable Fluid Sim', 'false')),
132         (BoolOption('WITH_BF_YAFRAY', 'Enable Yafray', 'true')),
133         (BoolOption('WITH_BF_OPENAL', 'Use OpenAL if true', '')),
134         ('BF_OPENAL', 'base path for OpenAL', ''),
135         ('BF_OPENAL_INC', 'include path for python headers', ''),
136         ('BF_OPENAL_LIB', 'Path to OpenAL library', ''),
137         ('BF_OPENAL_LIBPATH', 'Path to OpenAL library', ''),
138
139         (BoolOption('WITH_BF_SDL', 'Use SDL if true', '')),
140         ('BF_SDL', 'SDL base path', ''),
141         ('BF_SDL_INC', 'SDL include path', ''),     #$(shell $(BF_SDL)/bin/sdl-config --cflags)
142         ('BF_SDL_LIB', 'SDL library', ''),      #$(shell $(BF_SDL)/bin/sdl-config --libs) -lSDL_mixer
143         ('BF_SDL_LIBPATH', 'SDL library path', ''),
144
145         ('BF_PTHREADS', 'Pthreads base path', ''),
146         ('BF_PTHREADS_INC', 'Pthreads include path', ''),
147         ('BF_PTHREADS_LIB', 'Pthreads library', ''),
148         ('BF_PTHREADS_LIBPATH', 'Pthreads library path', ''),
149
150         (BoolOption('WITH_BF_FMOD', 'Use FMOD if true', 'false')),
151         #  BF_FMOD = $(LCGDIR)/fmod
152
153         (BoolOption('WITH_BF_OPENEXR', 'Use OPENEXR if true', 'true')),
154         ('BF_OPENEXR', 'OPENEXR base path', ''),
155         ('BF_OPENEXR_INC', 'OPENEXR include path', ''),
156         ('BF_OPENEXR_LIB', 'OPENEXR library', ''),
157         ('BF_OPENEXR_LIBPATH', 'OPENEXR library path', ''),
158
159         (BoolOption('WITH_BF_FFMPEG', 'Use FFMPEG if true', 'false')),
160         ('BF_FFMPEG', 'FFMPEG base path', ''),
161         ('BF_FFMPEG_LIB', 'FFMPEG library', ''),
162
163         ('BF_FFMPEG_INC', 'FFMPEG includes', ''),
164         ('BF_FFMPEG_LIBPATH', 'FFMPEG library path', ''),
165         
166
167         (BoolOption('WITH_BF_JPEG', 'Use JPEG if true', 'true')),
168         ('BF_JPEG', 'JPEG base path', ''),
169         ('BF_JPEG_INC', 'JPEG include path', ''),
170         ('BF_JPEG_LIB', 'JPEG library', ''),
171         ('BF_JPEG_LIBPATH', 'JPEG library path', ''),
172
173         (BoolOption('WITH_BF_PNG', 'Use PNG if true', 'true')),
174         ('BF_PNG', 'PNG base path', ''),
175         ('BF_PNG_INC', 'PNG include path', ''),
176         ('BF_PNG_LIB', 'PNG library', ''),
177         ('BF_PNG_LIBPATH', 'PNG library path', ''),
178
179         ('BF_TIFF', 'TIFF base path', ''),
180         ('BF_TIFF_INC', 'TIFF include path', ''),
181
182         (BoolOption('WITH_BF_ZLIB', 'Use ZLib if true', 'true')),
183         ('BF_ZLIB', 'ZLib base path', ''),
184         ('BF_ZLIB_INC', 'ZLib include path', ''),
185         ('BF_ZLIB_LIB', 'ZLib library', ''),
186         ('BF_ZLIB_LIBPATH', 'ZLib library path', ''),
187
188         (BoolOption('WITH_BF_INTERNATIONAL', 'Use Gettext and Freetype if true', 'true')),
189
190         ('BF_GETTEXT', 'gettext base path', ''),
191         ('BF_GETTEXT_INC', 'gettext include path', ''),
192         ('BF_GETTEXT_LIB', 'gettext library', ''),
193         ('BF_GETTEXT_LIBPATH', 'gettext library path', ''),
194         
195         (BoolOption('WITH_BF_ICONV', 'Use iconv if true', 'true')),
196         ('BF_ICONV', 'iconv base path', ''),
197         ('BF_ICONV_INC', 'iconv include path', ''),
198         ('BF_ICONV_LIB', 'iconv library', ''),
199         ('BF_ICONV_LIBPATH', 'iconv library path', ''),
200         
201         (BoolOption('WITH_BF_GAMEENGINE', 'Build with gameengine' , 'true')),
202
203         (BoolOption('WITH_BF_ODE', 'Use ODE if true', 'true')),
204         ('BF_ODE', 'ODE base path', ''),
205         ('BF_ODE_INC', 'ODE include path' , ''),
206         ('BF_ODE_LIB', 'ODE library', ''),
207
208         (BoolOption('WITH_BF_BULLET', 'Use Bullet if true', 'true')),
209         ('BF_BULLET', 'Bullet base dir', ''),
210         ('BF_BULLET_INC', 'Bullet include path', ''),
211         ('BF_BULLET_LIB', 'Bullet library', ''),
212         
213         ('BF_SOLID', 'Solid base dir', '#/extern/solid'),
214         ('BF_SOLID_INC', 'Solid include path', ''),
215         ('BF_WINTAB', 'WinTab base dir', ''),
216         ('BF_WINTAB_INC', 'WinTab include dir', ''),
217 ##
218 ##WITH_BF_NSPR = 'true'
219 ##BF_NSPR = $(LCGDIR)/nspr
220 ##BF_NSPR_INC = -I$(BF_NSPR)/include -I$(BF_NSPR)/include/nspr
221 ##BF_NSPR_LIB = 
222 ### Uncomment the following line to use Mozilla inplace of netscape
223 ##CPPFLAGS += -DMOZ_NOT_NET
224 ### Location of MOZILLA/Netscape header files...
225 ##BF_MOZILLA = $(LCGDIR)/mozilla
226 ##BF_MOZILLA_INC = -I$(BF_MOZILLA)/include/mozilla/nspr -I$(BF_MOZILLA)/include/mozilla -I$(BF_MOZILLA)/include/mozilla/xpcom -I$(BF_MOZILLA)/include/mozilla/idl
227 ##BF_MOZILLA_LIB = 
228 ### Will fall back to look in BF_MOZILLA_INC/nspr and BF_MOZILLA_LIB
229 ### if this is not set.
230 ##
231 ### Be paranoid regarding library creation (do not update archives)
232 ##BF_PARANOID = 'true'
233 ##
234 ### enable freetype2 support for text objects
235         ('BF_FREETYPE', 'Freetype base path', ''),
236         ('BF_FREETYPE_INC', 'Freetype include path', ''),
237         ('BF_FREETYPE_LIB', 'Freetype library', ''),
238         ('BF_FREETYPE_LIBPATH', 'Freetype library path', ''),
239
240         (BoolOption('WITH_BF_QUICKTIME', 'Use QuickTime if true', 'false')),
241         ('BF_QUICKTIME', 'QuickTime base path', ''),
242         ('BF_QUICKTIME_INC', 'QuickTime include path', ''),
243         ('BF_QUICKTIME_LIB', 'QuickTime library', ''),
244         ('BF_QUICKTIME_LIBPATH', 'QuickTime library path', ''),
245
246         (BoolOption('WITH_BF_STATICOPENGL', 'Use MESA if true', 'true')),
247         ('BF_OPENGL', 'OpenGL base path', ''),
248         ('BF_OPENGL_INC', 'OpenGL include path', ''),
249         ('BF_OPENGL_LIB', 'OpenGL libraries', ''),
250         ('BF_OPENGL_LIBPATH', 'OpenGL library path', ''),
251         ('BF_OPENGL_LIB_STATIC', 'OpenGL static libraries', ''),
252         ('BF_OPENGL_LINKFLAGS', 'OpenGL link flags', ''),
253         
254         (BoolOption('WITH_BF_FTGL', 'Use FTGL if true', 'true')),
255         ('BF_FTGL', 'FTGL base path', ''),
256         ('BF_FTGL_INC', 'FTGL include path', ''),
257         ('BF_FTGL_LIB', 'FTGL libraries', ''),
258
259         (BoolOption('WITH_BF_PLAYER', 'Build blenderplayer if true', 'false')),
260
261         ('CFLAGS', 'C-compiler flags', ''),
262         ('CCFLAGS', 'C++-compiler flags', ''),
263         ('CPPFLAGS', 'Defines', ''),
264         ('REL_CFLAGS', 'C release flags', ''),
265         ('REL_CCFLAGS', 'C++ release flags', ''),
266
267         ('C_WARN', 'C warning flags', ''),
268         ('CC_WARN', 'C++ warning flags', ''),
269
270         ('LLIBS', 'Platform libs', ''),
271         ('PLATFORM_LINKFLAGS', 'Platform linkflags', ''),
272
273         (BoolOption('BF_PROFILE', 'Add profiling information if true', 'false')),
274         ('BF_PROFILE_FLAGS', 'Profiling flags', ''),
275
276         (BoolOption('BF_DEBUG', 'Add debug flags if true', 'false')),
277         ('BF_DEBUG_FLAGS', 'Debug flags', ''),
278
279         (BoolOption('BF_BSC', 'Create .bsc files (msvc only)', 'true')),
280         
281         ('BF_BUILDDIR', 'Build dir', ''),
282         ('BF_INSTALLDIR', 'Installation dir', ''),
283
284         ('CC', 'C compiler to use', ''),
285         ('CXX', 'C++ compiler to use', ''),
286
287         (BoolOption('BF_BUILDINFO', 'Buildtime in splash if true', 'true')),
288
289         (BoolOption('BF_TWEAK_MODE', 'Enable tweak mode if true', 'false')),
290
291     ) # end of opts.AddOptions()
292
293     return localopts
294