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