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