SconsTests/wxconfig.py

   1 #
   2 # SCons python library: wxWidgets configuration
   3 #
   4 # \author Willem van Engen <wvengen@stack.nl>
   5 # \date created 2006/10/16
   6 # \version v 1.3.2.2 2006/11/24 14:26:47 willem Exp
   7 #
   8 import os, os.path
   9 import re
  10 import glob
  11 import string
  12
  13 # Runs a system command and returns return value and output
  14 def SystemBacktick(program):
  15     # Run and return result
  16     pipe = os.popen(program + ' 2>&1') # TODO: properly redirect stderr to stdout
  17     output = pipe.read()
  18     retcode = pipe.close() or 0
  19     return [retcode, output]
  20
  21 def SystemWXConfig(env, args):
  22     if env['PLATFORM'] == 'win32':
  23         return SystemBacktick(env['wxconfig']+' --wxcfg='+env['ENV']['WXCFG']+' '+args+env['wxconfig_postargs'])
  24     else:
  25         return SystemBacktick(env['wxconfig']+' '+args+env['wxconfig_postargs'])
  26
  27 # Check version of wx-config
  28 # It succeeds with a warning if version check failed.
  29 def CheckWXConfigVersion(context, version):
  30     releaseversion = SystemWXConfig(context.env,'--release')[1]
  31     try:
  32         if float(version) > float(releaseversion.strip()):
  33             return False
  34     except (ValueError, TypeError):
  35         context.Message('version check failed, but ok... ')
  36         return True
  37     return True
  38
  39 # Check if requested components exist in wxWidgets
  40 def CheckWXConfigComponents(context, libraries):
  41     # set components, method depending on wxWidgets version
  42     if CheckWXConfigVersion(context, '2.6'):
  43         context.env['wxconfig_postargs'] += ' '+string.join(libraries,',')
  44         return SystemWXConfig(context.env, '--libs ')[0] == 0
  45     # version 2.4 or below, only gl is an optional component with special flag
  46     if 'gl' in libraries:
  47         context.env['wxconfig'] += ' --gl-libs'
  48         return SystemWXConfig(context.env, '--libs')[0] == 0
  49
  50     # no optional components can be checked, it should be allright
  51     return True
  52
  53
  54 # Find wx-config with suitable settings. It tries to use a debug configuration if requested,
  55 # but reverts to release or default when that fails.
  56 def CheckWXConfigWin(context, version, debug):
  57     context.Message('Checking for wxWidgets >= %s... '%version)
  58
  59     # Some environment variables are required for wx-config to work, check them.
  60     if 'WXWIN' not in context.env['ENV']:
  61         # TODO: maybe try some default location like "C:\Program Files\wxWidgets-*" or registry
  62         context.Message('please set WXWIN in environment... ')
  63         return False
  64
  65     # If there's no WXCFG, either there is only one config or we try to find out.
  66     if 'WXCFG' not in context.env['ENV']:
  67         # TODO: try to find one in some sensible order from alternatives
  68         # Current guess is: visual studio static, non-unicode
  69
  70         # Try debugging version first if requested, else fallback to release
  71         if debug:
  72             context.env['ENV']['WXCFG'] = 'vc_lib\mswd'
  73             if SystemWXConfig(context.env,'--libs')[0] == 0:
  74                 return CheckWXConfigVersion(context, version)
  75
  76         # Non-debug
  77         context.env['ENV']['WXCFG'] = 'vc_lib\msw'
  78         if SystemWXConfig(context.env,'--libs')[0] == 0:
  79             # this is the only configuration: use it
  80             return CheckWXConfigVersion(context, version)
  81
  82         context.Message('please set WXCFG in environment... ')
  83         return False
  84
  85     # WXCFG is in environment, nice.
  86     # Try a debugging version if requested: postfix WXCFG with 'd'
  87     if debug:
  88         oldwxcfg = context.env['ENV']['WXCFG']
  89         context.env['ENV']['WXCFG'] += 'd'
  90         if SystemWXConfig(context.env,'--libs')[0] == 0:
  91             return CheckWXConfigVersion(context, version)
  92         # Failed: revert to plain WXCFG, use existing environment
  93         context.env['ENV']['WXCFG'] = oldwxcfg
  94
  95     if SystemWXConfig(context.env,'--libs')[0] == 0:
  96         return CheckWXConfigVersion(context, version)
  97
  98     # Everything failed ...
  99     return False
 100
 101
 102 def CheckWXConfigPosixFind(context, debug):
 103     # Find a wx-config compatible pathname
 104     # wx*-config --> wx*-[0-9]+\.[0-9]+-config / wx<platform>-<version>-config
 105
 106     if (context.env['wxconfig']):
 107         return context.env['wxconfig']
 108
 109     dbglist = []
 110     rellist = []
 111     cfgre = re.compile('.*?\/wx(\w+?)(d?)-(\d+\.\d+)-config')
 112     for dir in context.env['ENV']['PATH'].split(':'):
 113         for cfgprog in glob.glob(os.path.join(dir,'wx*-config')):
 114             m = cfgre.match(cfgprog)
 115             if m and not m.group(1) == 'base':
 116                 # add to either debug or release list
 117                 if m.group(2) == 'release':
 118                     rellist.append(cfgprog)
 119                 else:
 120                     dbglist.append(cfgprog)
 121
 122     # TODO: sort on version
 123
 124     # Now pick the right one
 125     if debug and len(dbglist)>0:
 126         return dbglist[0]
 127
 128     if len(rellist)>0:
 129         return rellist[0]
 130
 131     # Too bad
 132     return False
 133
 134
 135 def CheckWXConfigPosix(context, version, debug):
 136     # TODO: try several wx-config names
 137     context.Message('Checking for wxWidgets >= %s... '%version)
 138
 139     # If supplied wx-config doesn't work, try to find another one
 140     if SystemWXConfig(context.env,'--libs')[0] != 0:
 141         wx_prog = CheckWXConfigPosixFind(context, debug)
 142         if not wx_prog:
 143             context.Message('not found... ')
 144             return False
 145         context.env['wxconfig'] = wx_prog
 146
 147     if not debug:
 148         return CheckWXConfigVersion(context, version)
 149
 150     # use `wx-config --debug` if it's in its help
 151     helpoutput = SystemWXConfig(context.env,'--help')[1]
 152     if helpoutput.find('--debug') != -1:
 153         context.Message('--debug')
 154         if SystemWXConfig(context.env,'--debug --libs')[0] == 0:
 155             context.env['wxconfig'] = context.env['wxconfig'] +' --debug'
 156             return CheckWXConfigVersion(context, version)
 157
 158     # If it's plain wx-config, we may need to look for another one for debugging
 159     if context.env['wxconfig'] == 'wx-config':
 160         wx_prog = CheckWXConfigPosixFind(context, debug)
 161         if wx_prog:
 162             context.env['wxconfig']  = wx_prog
 163
 164     # TODO: possibly warning message when using release instead of debug
 165     return CheckWXConfigVersion(context, version)
 166
 167
 168 def CheckWXConfig(context, version, components, debug = False):
 169     context.env['wxconfig_postargs']= ''
 170
 171     # Try to find it in path
 172     try:
 173         context.env['wxconfig']
 174     except KeyError:
 175         wx_prog = context.env.WhereIs('wx-config')
 176         if wx_prog == None:
 177             # You could supply wx-config.exe as a fallback option.
 178             #wx_prog = os.path.join('scons','wx-config')
 179             context.Message('wx-config not found...')
 180             return False
 181         context.env['wxconfig'] = wx_prog
 182
 183     # Get wx-config invocation and check version
 184     if context.env['PLATFORM'] == 'win32':
 185         res = CheckWXConfigWin(context, version, debug)
 186     else:
 187         res = CheckWXConfigPosix(context, version, debug)
 188
 189     # Make sure we have the required libraries
 190     if res:
 191         res = CheckWXConfigComponents(context, components)
 192         if not res:
 193             context.Message('not all components found ['+string.join(components,',')+']... ')
 194
 195     context.Result(res)
 196     return int(res)
 197
 198 def ParseWXConfig(env):
 199
 200     # Windows doesn't work with ParseConfig (yet) :(
 201     if env['PLATFORM'] == 'win32':
 202         # Use wx-config, yay!
 203         # ParseConfig() on windows is broken, so the following is done instead
 204         cflags = SystemWXConfig(env,'--cxxflags')[1]
 205         env.AppendUnique(CPPFLAGS = cflags.strip().split(' '))
 206         libs = SystemWXConfig(env,'--libs')[1]
 207         env.AppendUnique(LINKFLAGS = libs.strip().split(' '))
 208     else:
 209         # Here ParseConfig should really work
 210         env.ParseConfig(env['wxconfig']+' --cxxflags --libs'+env['wxconfig_postargs'])