Annotation of /trunk/SConstruct

import os, commands, platform, distutils.sysconfig, os.path

#------------------------------------------------------
# OPTIONS
#
# Note that if you set the options via the command line, they will be
# remembered in the file 'options.cache'. It's a feature ;-)

opts = Options(['options.cache', 'config.py'])
print "PLATFORM = ",platform.system()

# Import the outside environment
env = Environment(ENV=os.environ)

# Package linking option
opts.Add(EnumOption(
    'PACKAGE_LINKING'
    , 'Style of linking for external libraries'
    , 'DYNAMIC_PACKAGES'
    , ['DYNAMIC_PACKAGES', 'STATIC_PACKAGES', 'NO_PACKAGES']
))

# You can turn off building of Tcl/Tk interface
opts.Add(BoolOption(
    'WITHOUT_TCLTK_GUI'
    ,"Set to True if you don't want to build the original Tcl/Tk GUI."
    , False
))

# You can turn off the building of the Python interface
opts.Add(BoolOption(
    'WITHOUT_PYTHON'
    ,"Set to True if you don't want to build Python wrappers."
    , False
))

# Which solvers will we allow?
opts.Add(ListOption(
    'WITH_SOLVERS'
    ,"List of the solvers you want to build. The default is the minimum that"   
        +" works."
    ,["QRSLV","CMSLV"]
    ,['QRSLV','MPS','SLV','OPTSQP'
        ,'NGSLV','CMSLV','LRSLV','MINOS','CONOPT'
        ,'LSOD','OPTSQP'
     ]
))

# Where will the local copy of the help files be kept?
opts.Add(PackageOption(
    'WITH_LOCAL_HELP'
    , "Directory containing the local copy of the help files (optional)"
    , "no"
))

# Will bintoken support be enabled?
opts.Add(BoolOption(
    'WITH_BINTOKEN'
    ,"Enable bintoken support? This means compiling models as C-code before"
        +" running them, to increase solving speed for large models."
    ,False
))

opts.Add(
    'DEFAULT_ASCENDLIBRARY'
    ,"Set the default value of the ASCENDLIBRARY -- the location where"
        +" ASCEND will look for models when running ASCEND"
    ,os.path.expanduser("~/src/ascend/trunk/models")
)

# Where will the 'Makefile.bt' file be installed

# TODO: add install options

# TODO: OTHER OPTIONS?

# TODO: flags for optimisation

# TODO: turning on/off bintoken functionality

opts.Update(env)
opts.Save('options.cache',env)

Help(opts.GenerateHelpText(env))

env.Append(CPPDEFINES=env['PACKAGE_LINKING'])

with_tcltk_gui = (env['WITHOUT_TCLTK_GUI']==False)

with_python = (env['WITHOUT_PYTHON']==False)

print "SOLVERS:",env['WITH_SOLVERS']

print "WITH_LOCAL_HELP:",env['WITH_LOCAL_HELP']
print "WITH_BINTOKEN:",env['WITH_BINTOKEN']
print "DEFAULT_ASCENDLIBRARY:",env['DEFAULT_ASCENDLIBRARY']

subst_dict = {
    '@WEBHELPROOT@':'http://pye.dyndns.org/ascend/manual/'
    , '@GLADE_FILE@':'glade/ascend.glade'
    , '@DEFAULT_ASCENDLIBRARY@':env['DEFAULT_ASCENDLIBRARY']
    , '@ASCEND_ICON@':'glade/ascend.png'
    , '@HELP_ROOT@':''
}

if env['WITH_LOCAL_HELP']:
    subst_dict['@HELP_ROOT@']=env['WITH_LOCAL_HELP']
        
env.Append(SUBST_DICT=subst_dict)

#------------------------------------------------------
# CONFIGURATION

conf = Configure(env
    , custom_tests = { 
#       'CheckIsNan' : CheckIsNan
#       ,'CheckCppUnitConfig' : CheckCppUnitConfig
    } 
    , config_h = "config.h"
)

# Math library
if not conf.CheckLibWithHeader(['m','c','libc'], 'math.h', 'C'):
    print 'Did not find libm.a or m.lib, exiting!'
    Exit(1)

# Where is 'isnan'?

if not conf.CheckFunc('isnan'):
    print "Didn't find isnan"
    Exit(1)

# Tcl/Tk
if not conf.CheckHeader('tcl.h'):
    with_tcltk_gui = False

if not conf.CheckHeader('tk.h'):
    with_tcltk_gui = False

if not conf.CheckLib('tcl'):
    with_tcltk_gui = False

if not conf.CheckLib('tk'):
    with_tcktk_gui = False


# Python... obviously we're already running python, so we just need to
# check that we can link to the python library OK:

if platform.system()=="Windows":
    #conf.env.Append(LIBPATH='c:\Python24\libs')
    #conf.env.Append(CPPPATH='c:\Python24\include')
    #python_header='Python.h'
    python_lib='python24'
    #python_libpath=['c:\\Python24\\libs']
    #python_cpppath=['c:\\Python24\\include']
else:
    #python_header='python2.4/Python.h'
    python_lib='python2.4'
    #python_libpath=[]
    #python_cpppath=['/usr/include/python2.4']

#if not conf.CheckLibWithHeader(python_lib,python_header,'C'
#       , LIBPATH=[distutils.sysconfig.PREFIX+"/libs"]
#       , CPPPATH=[distutils.sysconfig.get_python_inc()]
#):
#   print "Didn't find Python 2.4 ("+python_lib+")"
#   with_python = False
#else:


# SWIG version
env['SWIG']=['c:\\msys\\1.0\\home\\john\\swigwin-1.3.29\\swig.exe']
env['ENV']['SWIGFEATURES']='-O'


# TODO: -D_HPUX_SOURCE is needed

# TODO: check size of void*

# TODO: detect if dynamic libraries are possible or not

conf.Finish()

env.Append(PYTHON_LIBPATH=[distutils.sysconfig.PREFIX+"/libs"])
env.Append(PYTHON_LIB=[python_lib])
env.Append(PYTHON_CPPPATH=[distutils.sysconfig.get_python_inc()])
print "PYTHON_LIBPATH =",env['PYTHON_LIBPATH']
print "PYTHON_CPPPATH =",env['PYTHON_CPPPATH']

#------------------------------------------------------
# RECIPE: 'SubstInFile', used in pygtk SConscript

import re
from SCons.Script import *  # the usual scons stuff you get in a SConscript

def TOOL_SUBST(env):
    """Adds SubstInFile builder, which substitutes the keys->values of SUBST_DICT
    from the source to the target.
    The values of SUBST_DICT first have any construction variables expanded
    (its keys are not expanded).
    If a value of SUBST_DICT is a python callable function, it is called and
    the result is expanded as the value.
    If there's more than one source and more than one target, each target gets
    substituted from the corresponding source.
    """
    env.Append(TOOLS = 'SUBST')
    def do_subst_in_file(targetfile, sourcefile, dict):
        """Replace all instances of the keys of dict with their values.
        For example, if dict is {'%VERSION%': '1.2345', '%BASE%': 'MyProg'},
        then all instances of %VERSION% in the file will be replaced with 1.2345 etc.
        """
        try:
            f = open(sourcefile, 'rb')
            contents = f.read()
            f.close()
        except:
            raise SCons.Errors.UserError, "Can't read source file %s"%sourcefile
        for (k,v) in dict.items():
            contents = re.sub(k, v, contents)
        try:
            f = open(targetfile, 'wb')
            f.write(contents)
            f.close()
        except:
            raise SCons.Errors.UserError, "Can't write target file %s"%targetfile
        return 0 # success

    def subst_in_file(target, source, env):
        if not env.has_key('SUBST_DICT'):
            raise SCons.Errors.UserError, "SubstInFile requires SUBST_DICT to be set."
        d = dict(env['SUBST_DICT']) # copy it
        for (k,v) in d.items():
            if callable(v):
                d[k] = env.subst(v())
            elif SCons.Util.is_String(v):
                d[k]=env.subst(v)
            else:
                raise SCons.Errors.UserError, "SubstInFile: key %s: %s must be a string or callable"%(k, repr(v))
        for (t,s) in zip(target, source):
            return do_subst_in_file(str(t), str(s), d)

    def subst_in_file_string(target, source, env):
        """This is what gets printed on the console."""
        return '\n'.join(['Substituting vars from %s into %s'%(str(s), str(t))
                          for (t,s) in zip(target, source)])

    def subst_emitter(target, source, env):
        """Add dependency from substituted SUBST_DICT to target.
        Returns original target, source tuple unchanged.
        """
        d = env['SUBST_DICT'].copy() # copy it
        for (k,v) in d.items():
            if callable(v):
                d[k] = env.subst(v())
            elif SCons.Util.is_String(v):
                d[k]=env.subst(v)
        Depends(target, SCons.Node.Python.Value(d))
        return target, source

    subst_action=SCons.Action.Action(subst_in_file, subst_in_file_string)
    env['BUILDERS']['SubstInFile'] = Builder(action=subst_action, emitter=subst_emitter)

TOOL_SUBST(env)

#------------------------------------------------------
# SUBDIRECTORIES....


env.Append(CPPPATH=['..'])

env.SConscript(['base/generic/general/SConscript'],'env')

env.SConscript(['base/generic/utilities/SConscript'],'env')

env.SConscript(['base/generic/compiler/SConscript'],'env')

env.SConscript(['base/generic/solver/SConscript'],'env')

env.SConscript(['base/generic/packages/SConscript'],'env')

if with_tcltk_gui:
    env.SConscript(['tcltk98/generic/interface/SConscript'],'env')
else:
    print "Skipping... Tcl/Tk GUI isn't being built"

if with_python:
    env.SConscript(['pygtk/interface/SConscript'],'env')
else:
    print "Skipping... Python GUI isn't being built"


1	johnpye	393	import os, commands, platform, distutils.sysconfig, os.path
2	johnpye	385
3			#------------------------------------------------------
4			# OPTIONS
5	johnpye	392	#
6			# Note that if you set the options via the command line, they will be
7			# remembered in the file 'options.cache'. It's a feature ;-)
8	johnpye	385
9			opts = Options(['options.cache', 'config.py'])
10			print "PLATFORM = ",platform.system()
11
12	johnpye	392	# Import the outside environment
13			env = Environment(ENV=os.environ)
14	johnpye	385
15			# Package linking option
16	johnpye	386	opts.Add(EnumOption(
17			'PACKAGE_LINKING'
18	johnpye	385	, 'Style of linking for external libraries'
19			, 'DYNAMIC_PACKAGES'
20	johnpye	386	, ['DYNAMIC_PACKAGES', 'STATIC_PACKAGES', 'NO_PACKAGES']
21			))
22	johnpye	385
23	johnpye	392	# You can turn off building of Tcl/Tk interface
24	johnpye	386	opts.Add(BoolOption(
25			'WITHOUT_TCLTK_GUI'
26			,"Set to True if you don't want to build the original Tcl/Tk GUI."
27			, False
28			))
29
30	johnpye	392	# You can turn off the building of the Python interface
31	johnpye	387	opts.Add(BoolOption(
32			'WITHOUT_PYTHON'
33			,"Set to True if you don't want to build Python wrappers."
34			, False
35			))
36
37	johnpye	392	# Which solvers will we allow?
38			opts.Add(ListOption(
39			'WITH_SOLVERS'
40	johnpye	393	,"List of the solvers you want to build. The default is the minimum that"
41			+" works."
42	johnpye	392	,["QRSLV","CMSLV"]
43			,['QRSLV','MPS','SLV','OPTSQP'
44			,'NGSLV','CMSLV','LRSLV','MINOS','CONOPT'
45			,'LSOD','OPTSQP'
46			]
47			))
48
49	johnpye	393	# Where will the local copy of the help files be kept?
50			opts.Add(PackageOption(
51			'WITH_LOCAL_HELP'
52			, "Directory containing the local copy of the help files (optional)"
53			, "no"
54			))
55
56			# Will bintoken support be enabled?
57			opts.Add(BoolOption(
58			'WITH_BINTOKEN'
59			,"Enable bintoken support? This means compiling models as C-code before"
60			+" running them, to increase solving speed for large models."
61			,False
62			))
63
64			opts.Add(
65			'DEFAULT_ASCENDLIBRARY'
66			,"Set the default value of the ASCENDLIBRARY -- the location where"
67			+" ASCEND will look for models when running ASCEND"
68			,os.path.expanduser("~/src/ascend/trunk/models")
69			)
70
71			# Where will the 'Makefile.bt' file be installed
72
73	johnpye	392	# TODO: add install options
74
75			# TODO: OTHER OPTIONS?
76
77			# TODO: flags for optimisation
78
79	johnpye	393	# TODO: turning on/off bintoken functionality
80
81	johnpye	385	opts.Update(env)
82			opts.Save('options.cache',env)
83
84			Help(opts.GenerateHelpText(env))
85
86			env.Append(CPPDEFINES=env['PACKAGE_LINKING'])
87
88	johnpye	386	with_tcltk_gui = (env['WITHOUT_TCLTK_GUI']==False)
89
90	johnpye	387	with_python = (env['WITHOUT_PYTHON']==False)
91
92	johnpye	392	print "SOLVERS:",env['WITH_SOLVERS']
93	johnpye	393
94			print "WITH_LOCAL_HELP:",env['WITH_LOCAL_HELP']
95			print "WITH_BINTOKEN:",env['WITH_BINTOKEN']
96			print "DEFAULT_ASCENDLIBRARY:",env['DEFAULT_ASCENDLIBRARY']
97
98			subst_dict = {
99			'@WEBHELPROOT@':'http://pye.dyndns.org/ascend/manual/'
100			, '@GLADE_FILE@':'glade/ascend.glade'
101			, '@DEFAULT_ASCENDLIBRARY@':env['DEFAULT_ASCENDLIBRARY']
102			, '@ASCEND_ICON@':'glade/ascend.png'
103			, '@HELP_ROOT@':''
104			}
105
106			if env['WITH_LOCAL_HELP']:
107			subst_dict['@HELP_ROOT@']=env['WITH_LOCAL_HELP']
108
109			env.Append(SUBST_DICT=subst_dict)
110
111	johnpye	385	#------------------------------------------------------
112			# CONFIGURATION
113
114			conf = Configure(env
115			, custom_tests = {
116			# 'CheckIsNan' : CheckIsNan
117			# ,'CheckCppUnitConfig' : CheckCppUnitConfig
118			}
119			, config_h = "config.h"
120			)
121
122			# Math library
123			if not conf.CheckLibWithHeader(['m','c','libc'], 'math.h', 'C'):
124			print 'Did not find libm.a or m.lib, exiting!'
125			Exit(1)
126
127			# Where is 'isnan'?
128
129			if not conf.CheckFunc('isnan'):
130			print "Didn't find isnan"
131			Exit(1)
132
133	johnpye	387	# Tcl/Tk
134	johnpye	386	if not conf.CheckHeader('tcl.h'):
135			with_tcltk_gui = False
136
137			if not conf.CheckHeader('tk.h'):
138			with_tcltk_gui = False
139
140			if not conf.CheckLib('tcl'):
141			with_tcltk_gui = False
142
143			if not conf.CheckLib('tk'):
144			with_tcktk_gui = False
145
146	johnpye	392
147	johnpye	395	# Python... obviously we're already running python, so we just need to
148			# check that we can link to the python library OK:
149
150	johnpye	391	if platform.system()=="Windows":
151	johnpye	392	#conf.env.Append(LIBPATH='c:\Python24\libs')
152			#conf.env.Append(CPPPATH='c:\Python24\include')
153	johnpye	395	#python_header='Python.h'
154			python_lib='python24'
155	johnpye	392	#python_libpath=['c:\\Python24\\libs']
156			#python_cpppath=['c:\\Python24\\include']
157	johnpye	391	else:
158	johnpye	395	#python_header='python2.4/Python.h'
159			python_lib='python2.4'
160	johnpye	392	#python_libpath=[]
161			#python_cpppath=['/usr/include/python2.4']
162	johnpye	391
163	johnpye	395	#if not conf.CheckLibWithHeader(python_lib,python_header,'C'
164			# , LIBPATH=[distutils.sysconfig.PREFIX+"/libs"]
165			# , CPPPATH=[distutils.sysconfig.get_python_inc()]
166			#):
167			# print "Didn't find Python 2.4 ("+python_lib+")"
168			# with_python = False
169			#else:
170	johnpye	387
171	johnpye	395
172			# SWIG version
173			env['SWIG']=['c:\\msys\\1.0\\home\\john\\swigwin-1.3.29\\swig.exe']
174			env['ENV']['SWIGFEATURES']='-O'
175
176
177	johnpye	385	# TODO: -D_HPUX_SOURCE is needed
178
179			# TODO: check size of void*
180
181	johnpye	393	# TODO: detect if dynamic libraries are possible or not
182
183	johnpye	395	conf.Finish()
184
185			env.Append(PYTHON_LIBPATH=[distutils.sysconfig.PREFIX+"/libs"])
186			env.Append(PYTHON_LIB=[python_lib])
187			env.Append(PYTHON_CPPPATH=[distutils.sysconfig.get_python_inc()])
188			print "PYTHON_LIBPATH =",env['PYTHON_LIBPATH']
189			print "PYTHON_CPPPATH =",env['PYTHON_CPPPATH']
190
191	johnpye	385	#------------------------------------------------------
192	johnpye	393	# RECIPE: 'SubstInFile', used in pygtk SConscript
193
194			import re
195	johnpye	395	from SCons.Script import * # the usual scons stuff you get in a SConscript
196	johnpye	393
197	johnpye	395	def TOOL_SUBST(env):
198			"""Adds SubstInFile builder, which substitutes the keys->values of SUBST_DICT
199			from the source to the target.
200			The values of SUBST_DICT first have any construction variables expanded
201			(its keys are not expanded).
202			If a value of SUBST_DICT is a python callable function, it is called and
203			the result is expanded as the value.
204			If there's more than one source and more than one target, each target gets
205			substituted from the corresponding source.
206	johnpye	393	"""
207	johnpye	395	env.Append(TOOLS = 'SUBST')
208			def do_subst_in_file(targetfile, sourcefile, dict):
209			"""Replace all instances of the keys of dict with their values.
210			For example, if dict is {'%VERSION%': '1.2345', '%BASE%': 'MyProg'},
211			then all instances of %VERSION% in the file will be replaced with 1.2345 etc.
212			"""
213			try:
214			f = open(sourcefile, 'rb')
215			contents = f.read()
216			f.close()
217			except:
218			raise SCons.Errors.UserError, "Can't read source file %s"%sourcefile
219			for (k,v) in dict.items():
220			contents = re.sub(k, v, contents)
221			try:
222			f = open(targetfile, 'wb')
223			f.write(contents)
224			f.close()
225			except:
226			raise SCons.Errors.UserError, "Can't write target file %s"%targetfile
227			return 0 # success
228	johnpye	393
229	johnpye	395	def subst_in_file(target, source, env):
230			if not env.has_key('SUBST_DICT'):
231			raise SCons.Errors.UserError, "SubstInFile requires SUBST_DICT to be set."
232			d = dict(env['SUBST_DICT']) # copy it
233			for (k,v) in d.items():
234			if callable(v):
235			d[k] = env.subst(v())
236			elif SCons.Util.is_String(v):
237			d[k]=env.subst(v)
238			else:
239			raise SCons.Errors.UserError, "SubstInFile: key %s: %s must be a string or callable"%(k, repr(v))
240			for (t,s) in zip(target, source):
241			return do_subst_in_file(str(t), str(s), d)
242	johnpye	393
243	johnpye	395	def subst_in_file_string(target, source, env):
244			"""This is what gets printed on the console."""
245			return '\n'.join(['Substituting vars from %s into %s'%(str(s), str(t))
246			for (t,s) in zip(target, source)])
247	johnpye	393
248	johnpye	395	def subst_emitter(target, source, env):
249			"""Add dependency from substituted SUBST_DICT to target.
250			Returns original target, source tuple unchanged.
251			"""
252			d = env['SUBST_DICT'].copy() # copy it
253			for (k,v) in d.items():
254			if callable(v):
255			d[k] = env.subst(v())
256			elif SCons.Util.is_String(v):
257			d[k]=env.subst(v)
258			Depends(target, SCons.Node.Python.Value(d))
259			return target, source
260	johnpye	393
261	johnpye	395	subst_action=SCons.Action.Action(subst_in_file, subst_in_file_string)
262			env['BUILDERS']['SubstInFile'] = Builder(action=subst_action, emitter=subst_emitter)
263
264			TOOL_SUBST(env)
265
266	johnpye	393	#------------------------------------------------------
267	johnpye	385	# SUBDIRECTORIES....
268
269	johnpye	393
270	johnpye	385	env.Append(CPPPATH=['..'])
271
272			env.SConscript(['base/generic/general/SConscript'],'env')
273
274			env.SConscript(['base/generic/utilities/SConscript'],'env')
275
276			env.SConscript(['base/generic/compiler/SConscript'],'env')
277
278			env.SConscript(['base/generic/solver/SConscript'],'env')
279
280			env.SConscript(['base/generic/packages/SConscript'],'env')
281	johnpye	386
282			if with_tcltk_gui:
283			env.SConscript(['tcltk98/generic/interface/SConscript'],'env')
284	johnpye	391	else:
285			print "Skipping... Tcl/Tk GUI isn't being built"
286	johnpye	386
287	johnpye	387	if with_python:
288			env.SConscript(['pygtk/interface/SConscript'],'env')
289	johnpye	391	else:
290			print "Skipping... Python GUI isn't being built"
291
292	johnpye	393