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