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