jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added documentation and explanatory comments to vccexe

Browse source
This commit is contained in:
Fredrik Høisæther Rasch 2017-03-26 17:08:41 +02:00
commit 3d21e2ab66
4 changed files with 117 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

40
tools/vccexe/vccenv.nim
View file

@ -1,18 +1,40 @@
## VCC compiler backend installation discovery using Visual Studio common tools
## environment variables.
import os
type
VccEnvVersion* = enum
vsUndefined = (0, ""),
vs90 = (90, "VS90COMNTOOLS"), # Visual Studio 2008
vs100 = (100, "VS100COMNTOOLS"), # Visual Studio 2010
vs110 = (110, "VS110COMNTOOLS"), # Visual Studio 2012
vs120 = (120, "VS120COMNTOOLS"), # Visual Studio 2013
vs140 = (140, "VS140COMNTOOLS") # Visual Studio 2015
VccEnvVersion* = enum ## The version of the Visual Studio C/C++ Developer Environment to load
## Valid versions are Versions of Visual Studio that permanently set a COMNTOOLS
## environment variable. That includes Visual Studio version up to and including
## Visual Studio 2015
vsUndefined = (0, ""), ## Version not specified, use latest recogized version on the system
vs90 = (90, "VS90COMNTOOLS"), ## Visual Studio 2008
vs100 = (100, "VS100COMNTOOLS"), ## Visual Studio 2010
vs110 = (110, "VS110COMNTOOLS"), ## Visual Studio 2012
vs120 = (120, "VS120COMNTOOLS"), ## Visual Studio 2013
vs140 = (140, "VS140COMNTOOLS") ## Visual Studio 2015
const
vcvarsallRelativePath = joinPath("..", "..", "VC", "vcvarsall")
vcvarsallRelativePath = joinPath("..", "..", "VC", "vcvarsall") ## Relative path from the COMNTOOLS path to the vcvarsall file.
proc vccEnvVcVarsAllPath*(version: VccEnvVersion = vsUndefined): string =
## Returns the path to the VCC Developer Command Prompt executable for the specified VCC version.
##
## Returns `nil` if the specified VCC compiler backend installation was not found.
##
## If the `version` parameter is omitted or set to `vsUndefined`, `vccEnvVcVarsAllPath` searches
## for the latest recognizable version of the VCC tools it can find.
##
## `vccEnvVcVarsAllPath` uses the COMNTOOLS environment variables to find the Developer Command Prompt
## executable path. The COMNTOOLS environment variable are permanently set when Visual Studio is installed.
## Each version of Visual Studio has its own COMNTOOLS environment variable. E.g.: Visual Studio 2015 sets
## The VS140COMNTOOLS environment variable.
##
## Note: Beginning with Visual Studio 2017, the installers no longer set environment variables to allow for
## multiple side-by-side installations of Visual Studio. Therefore, `vccEnvVcVarsAllPath` cannot be used
## to detect the VCC Developer Command Prompt executable path for Visual Studio 2017 and later.
proc vccEnvVcVarsAllPath*(version: VccEnvVersion = vsUndefined): string =
if version == vsUndefined:
for tryVersion in [vs140, vs120, vs110, vs100, vs90]:
let tryPath = vccEnvVcVarsAllPath(tryVersion)