## __COPYRIGHT__## Permission is hereby granted, free of charge, to any person obtaining# a copy of this software and associated documentation files (the# "Software"), to deal in the Software without restriction, including# without limitation the rights to use, copy, modify, merge, publish,# distribute, sublicense, and/or sell copies of the Software, and to# permit persons to whom the Software is furnished to do so, subject to# the following conditions:## The above copyright notice and this permission notice shall be included# in all copies or substantial portions of the Software.## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.#__revision__="__FILE__ __REVISION__ __DATE__ __DEVELOPER__"__doc__="""Module to detect Visual Studio and/or Visual C/C++"""importosimportSCons.ErrorsimportSCons.Utilfromcommonimportdebug, \
get_output, \
is_win64, \
normalize_env, \
parse_output, \
read_regimportSCons.Tool.MSCommon.vcclassVisualStudio(object):""" An abstract base class for trying to find installed versions of Visual Studio. """def__init__(self,version,**kw):self.version=versionkw['vc_version']=kw.get('vc_version',version)kw['sdk_version']=kw.get('sdk_version',version)self.__dict__.update(kw)self._cache={}#deffind_batch_file(self):vs_dir=self.get_vs_dir()ifnotvs_dir:debug('find_executable(): no vs_dir')returnNonebatch_file=os.path.join(vs_dir,self.batch_file_path)batch_file=os.path.normpath(batch_file)ifnotos.path.isfile(batch_file):debug('find_batch_file(): %s not on file system'%batch_file)returnNonereturnbatch_filedeffind_vs_dir_by_vc(self):SCons.Tool.MSCommon.vc.get_installed_vcs()dir=SCons.Tool.MSCommon.vc.find_vc_pdir(self.vc_version)ifnotdir:debug('find_vs_dir(): no installed VC %s'%self.vc_version)returnNonereturndirdeffind_vs_dir_by_reg(self):root='Software\\'ifis_win64():root=root+'Wow6432Node\\'forkeyinself.hkeys:ifkey=='use_dir':returnself.find_vs_dir_by_vc()key=root+keytry:comps=read_reg(key)exceptWindowsError,e:debug('find_vs_dir_by_reg(): no VS registry key %s'%repr(key))else:debug('find_vs_dir_by_reg(): found VS in registry: %s'%comps)returncompsreturnNonedeffind_vs_dir(self):""" Can use registry or location of VC to find vs dir First try to find by registry, and if that fails find via VC dir """ifTrue:vs_dir=self.find_vs_dir_by_reg()returnvs_direlse:returnself.find_vs_dir_by_vc()deffind_executable(self):vs_dir=self.get_vs_dir()ifnotvs_dir:debug('find_executable(): no vs_dir (%s)'%vs_dir)returnNoneexecutable=os.path.join(vs_dir,self.executable_path)executable=os.path.normpath(executable)ifnotos.path.isfile(executable):debug('find_executable(): %s not on file system'%executable)returnNonereturnexecutable#defget_batch_file(self):try:returnself._cache['batch_file']exceptKeyError:batch_file=self.find_batch_file()self._cache['batch_file']=batch_filereturnbatch_filedefget_executable(self):try:debug('get_executable using cache:%s'%self._cache['executable'])returnself._cache['executable']exceptKeyError:executable=self.find_executable()self._cache['executable']=executabledebug('get_executable not in cache:%s'%executable)returnexecutabledefget_vs_dir(self):try:returnself._cache['vs_dir']exceptKeyError:vs_dir=self.find_vs_dir()self._cache['vs_dir']=vs_dirreturnvs_dirdefget_supported_arch(self):try:returnself._cache['supported_arch']exceptKeyError:# RDEVE: for the time being use hardcoded lists# supported_arch = self.find_supported_arch()self._cache['supported_arch']=self.supported_archreturnself.supported_archdefreset(self):self._cache={}# The list of supported Visual Studio versions we know how to detect.## How to look for .bat file ?# - VS 2008 Express (x86):# * from registry key productdir, gives the full path to vsvarsall.bat. In# HKEY_LOCAL_MACHINE):# Software\Microsoft\VCEpress\9.0\Setup\VC\productdir# * from environmnent variable VS90COMNTOOLS: the path is then ..\..\VC# relatively to the path given by the variable.## - VS 2008 Express (WoW6432: 32 bits on windows x64):# Software\Wow6432Node\Microsoft\VCEpress\9.0\Setup\VC\productdir## - VS 2005 Express (x86):# * from registry key productdir, gives the full path to vsvarsall.bat. In# HKEY_LOCAL_MACHINE):# Software\Microsoft\VCEpress\8.0\Setup\VC\productdir# * from environmnent variable VS80COMNTOOLS: the path is then ..\..\VC# relatively to the path given by the variable.## - VS 2005 Express (WoW6432: 32 bits on windows x64): does not seem to have a# productdir ?## - VS 2003 .Net (pro edition ? x86):# * from registry key productdir. The path is then ..\Common7\Tools\# relatively to the key. The key is in HKEY_LOCAL_MACHINE):# Software\Microsoft\VisualStudio\7.1\Setup\VC\productdir# * from environmnent variable VS71COMNTOOLS: the path is the full path to# vsvars32.bat## - VS 98 (VS 6):# * from registry key productdir. The path is then Bin# relatively to the key. The key is in HKEY_LOCAL_MACHINE):# Software\Microsoft\VisualStudio\6.0\Setup\VC98\productdir## The first version found in the list is the one used by default if# there are multiple versions installed. Barring good reasons to# the contrary, this means we should list versions from most recent# to oldest. Pro versions get listed before Express versions on the# assumption that, by default, you'd rather use the version you paid# good money for in preference to whatever Microsoft makes available# for free.## If you update this list, update the documentation in Tool/msvs.xml.SupportedVSList=[# Visual Studio 2010# TODO: find the settings, perhaps from someone with a CTP copy?#VisualStudio('TBD',# hkey_root=r'TBD',# common_tools_var='TBD',# executable_path=r'TBD',# default_dirname='TBD',#),# Visual Studio 11# The batch file we look for is in the VC directory,# so the devenv.com executable is up in ..\..\Common7\IDE.VisualStudio('11.0',sdk_version='6.1',hkeys=[r'Microsoft\VisualStudio\11.0\Setup\VS\ProductDir'],common_tools_var='VS110COMNTOOLS',executable_path=r'Common7\IDE\devenv.com',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio 11',supported_arch=['x86','amd64'],),# Visual C++ 11 Express Edition# The batch file we look for is in the VC directory,# so the VCExpress.exe executable is up in ..\..\Common7\IDE.VisualStudio('11.0Exp',vc_version='11.0',sdk_version='6.1',hkeys=[r'Microsoft\VCExpress\11.0\Setup\VS\ProductDir'],common_tools_var='VS110COMNTOOLS',executable_path=r'Common7\IDE\VCExpress.exe',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio 11',supported_arch=['x86'],),# Visual Studio 2010# The batch file we look for is in the VC directory,# so the devenv.com executable is up in ..\..\Common7\IDE.VisualStudio('10.0',sdk_version='6.1',hkeys=[r'Microsoft\VisualStudio\10.0\Setup\VS\ProductDir'],common_tools_var='VS100COMNTOOLS',executable_path=r'Common7\IDE\devenv.com',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio 10',supported_arch=['x86','amd64'],),# Visual C++ 2010 Express Edition# The batch file we look for is in the VC directory,# so the VCExpress.exe executable is up in ..\..\Common7\IDE.VisualStudio('10.0Exp',vc_version='10.0',sdk_version='6.1',hkeys=[r'Microsoft\VCExpress\10.0\Setup\VS\ProductDir'],common_tools_var='VS100COMNTOOLS',executable_path=r'Common7\IDE\VCExpress.exe',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio 10',supported_arch=['x86'],),# Visual Studio 2008# The batch file we look for is in the VC directory,# so the devenv.com executable is up in ..\..\Common7\IDE.VisualStudio('9.0',sdk_version='6.1',hkeys=[r'Microsoft\VisualStudio\9.0\Setup\VS\ProductDir'],common_tools_var='VS90COMNTOOLS',executable_path=r'Common7\IDE\devenv.com',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio 9',supported_arch=['x86','amd64'],),# Visual C++ 2008 Express Edition# The batch file we look for is in the VC directory,# so the VCExpress.exe executable is up in ..\..\Common7\IDE.VisualStudio('9.0Exp',vc_version='9.0',sdk_version='6.1',hkeys=[r'Microsoft\VCExpress\9.0\Setup\VS\ProductDir'],common_tools_var='VS90COMNTOOLS',executable_path=r'Common7\IDE\VCExpress.exe',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio 9',supported_arch=['x86'],),# Visual Studio 2005# The batch file we look for is in the VC directory,# so the devenv.com executable is up in ..\..\Common7\IDE.VisualStudio('8.0',sdk_version='6.0A',hkeys=[r'Microsoft\VisualStudio\8.0\Setup\VS\ProductDir'],common_tools_var='VS80COMNTOOLS',executable_path=r'Common7\IDE\devenv.com',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio 8',supported_arch=['x86','amd64'],),# Visual C++ 2005 Express Edition# The batch file we look for is in the VC directory,# so the VCExpress.exe executable is up in ..\..\Common7\IDE.VisualStudio('8.0Exp',vc_version='8.0Exp',sdk_version='6.0A',hkeys=[r'Microsoft\VCExpress\8.0\Setup\VS\ProductDir'],common_tools_var='VS80COMNTOOLS',executable_path=r'Common7\IDE\VCExpress.exe',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio 8',supported_arch=['x86'],),# Visual Studio .NET 2003# The batch file we look for is in the Common7\Tools directory,# so the devenv.com executable is next door in ..\IDE.VisualStudio('7.1',sdk_version='6.0',hkeys=[r'Microsoft\VisualStudio\7.1\Setup\VS\ProductDir'],common_tools_var='VS71COMNTOOLS',executable_path=r'Common7\IDE\devenv.com',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio .NET 2003',supported_arch=['x86'],),# Visual Studio .NET# The batch file we look for is in the Common7\Tools directory,# so the devenv.com executable is next door in ..\IDE.VisualStudio('7.0',sdk_version='2003R2',hkeys=[r'Microsoft\VisualStudio\7.0\Setup\VS\ProductDir'],common_tools_var='VS70COMNTOOLS',executable_path=r'IDE\devenv.com',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio .NET',supported_arch=['x86'],),# Visual Studio 6.0VisualStudio('6.0',sdk_version='2003R1',hkeys=[r'Microsoft\VisualStudio\6.0\Setup\Microsoft Visual Studio\ProductDir','use_dir'],common_tools_var='VS60COMNTOOLS',executable_path=r'Common\MSDev98\Bin\MSDEV.COM',batch_file_path=r'Common7\Tools\vsvars32.bat',default_dirname='Microsoft Visual Studio',supported_arch=['x86'],),]SupportedVSMap={}forvsinSupportedVSList:SupportedVSMap[vs.version]=vs# Finding installed versions of Visual Studio isn't cheap, because it# goes not only to the registry but also to the disk to sanity-check# that there is, in fact, a Visual Studio directory there and that the# registry entry isn't just stale. Find this information once, when# requested, and cache it.InstalledVSList=NoneInstalledVSMap=Nonedefget_installed_visual_studios():globalInstalledVSListglobalInstalledVSMapifInstalledVSListisNone:InstalledVSList=[]InstalledVSMap={}forvsinSupportedVSList:debug('trying to find VS %s'%vs.version)ifvs.get_executable():debug('found VS %s'%vs.version)InstalledVSList.append(vs)InstalledVSMap[vs.version]=vsreturnInstalledVSListdefreset_installed_visual_studios():globalInstalledVSListglobalInstalledVSMapInstalledVSList=NoneInstalledVSMap=NoneforvsinSupportedVSList:vs.reset()# Need to clear installed VC's as well as they are used in finding# installed VS'sSCons.Tool.MSCommon.vc.reset_installed_vcs()# We may be asked to update multiple construction environments with# SDK information. When doing this, we check on-disk for whether# the SDK has 'mfc' and 'atl' subdirectories. Since going to disk# is expensive, cache results by directory.#SDKEnvironmentUpdates = {}##def set_sdk_by_directory(env, sdk_dir):# global SDKEnvironmentUpdates# try:# env_tuple_list = SDKEnvironmentUpdates[sdk_dir]# except KeyError:# env_tuple_list = []# SDKEnvironmentUpdates[sdk_dir] = env_tuple_list## include_path = os.path.join(sdk_dir, 'include')# mfc_path = os.path.join(include_path, 'mfc')# atl_path = os.path.join(include_path, 'atl')## if os.path.exists(mfc_path):# env_tuple_list.append(('INCLUDE', mfc_path))# if os.path.exists(atl_path):# env_tuple_list.append(('INCLUDE', atl_path))# env_tuple_list.append(('INCLUDE', include_path))## env_tuple_list.append(('LIB', os.path.join(sdk_dir, 'lib')))# env_tuple_list.append(('LIBPATH', os.path.join(sdk_dir, 'lib')))# env_tuple_list.append(('PATH', os.path.join(sdk_dir, 'bin')))## for variable, directory in env_tuple_list:# env.PrependENVPath(variable, directory)defmsvs_exists():return(len(get_installed_visual_studios())>0)defget_vs_by_version(msvs):globalInstalledVSMapglobalSupportedVSMapdebug('vs.py:get_vs_by_version()')ifmsvsnotinSupportedVSMap:msg="Visual Studio version %s is not supported"%repr(msvs)raiseSCons.Errors.UserError(msg)get_installed_visual_studios()vs=InstalledVSMap.get(msvs)debug('InstalledVSMap:%s'%InstalledVSMap)debug('vs.py:get_vs_by_version: found vs:%s'%vs)# Some check like this would let us provide a useful error message# if they try to set a Visual Studio version that's not installed.# However, we also want to be able to run tests (like the unit# tests) on systems that don't, or won't ever, have it installed.# It might be worth resurrecting this, with some configurable# setting that the tests can use to bypass the check.#if not vs:# msg = "Visual Studio version %s is not installed" % repr(msvs)# raise SCons.Errors.UserError, msgreturnvsdefget_default_version(env):"""Returns the default version string to use for MSVS. If no version was requested by the user through the MSVS environment variable, query all the available the visual studios through query_versions, and take the highest one. Return ------ version: str the default version. """if'MSVS'notinenvornotSCons.Util.is_Dict(env['MSVS']):versions=[vs.versionforvsinget_installed_visual_studios()]env['MSVS']={'VERSIONS':versions}else:versions=env['MSVS'].get('VERSIONS',[])if'MSVS_VERSION'notinenv:ifversions:env['MSVS_VERSION']=versions[0]#use highest version by defaultelse:env['MSVS_VERSION']=SupportedVSList[0].versionenv['MSVS']['VERSION']=env['MSVS_VERSION']returnenv['MSVS_VERSION']defget_default_arch(env):"""Return the default arch to use for MSVS if no version was requested by the user through the MSVS_ARCH environment variable, select x86 Return ------ arch: str """arch=env.get('MSVS_ARCH','x86')msvs=InstalledVSMap.get(env['MSVS_VERSION'])ifnotmsvs:arch='x86'elifnotarchinmsvs.get_supported_arch():fmt="Visual Studio version %s does not support architecture %s"raiseSCons.Errors.UserError(fmt%(env['MSVS_VERSION'],arch))returnarchdefmerge_default_version(env):version=get_default_version(env)arch=get_default_arch(env)defmsvs_setup_env(env):batfilename=msvs.get_batch_file()msvs=get_vs_by_version(version)ifmsvsisNone:return# XXX: I think this is broken. This will silently set a bogus tool instead# of failing, but there is no other way with the current scons tool# frameworkifbatfilenameisnotNone:vars=('LIB','LIBPATH','PATH','INCLUDE')msvs_list=get_installed_visual_studios()vscommonvarnames=[vs.common_tools_varforvsinmsvs_list]save_ENV=env['ENV']nenv=normalize_env(env['ENV'],['COMSPEC']+vscommonvarnames,force=True)try:output=get_output(batfilename,arch,env=nenv)finally:env['ENV']=save_ENVvars=parse_output(output,vars)fork,vinvars.items():env.PrependENVPath(k,v,delete_existing=1)defquery_versions():"""Query the system to get available versions of VS. A version is considered when a batfile is found."""msvs_list=get_installed_visual_studios()versions=[msvs.versionformsvsinmsvs_list]returnversions# Local Variables:# tab-width:4# indent-tabs-mode:nil# End:# vim: set expandtab tabstop=4 shiftwidth=4: