Files
UnrealEngineUWP/Engine/Source/Programs/DotNETCommon/DotNETUtilities/CsProjectInfo.cs
Ben Wright 297e433f87 Add all changes required for UWP on 4.21
(based from commit d2d9eab01bf364dce4edee40e6f4ac94b23a7d42)

(cherry picked from commit d072e2774e)
2020-05-12 13:08:08 +12:00

699 lines
25 KiB
C#

// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Xml;
namespace Tools.DotNETCommon
{
/// <summary>
/// Basic information from a preprocessed C# project file. Supports reading a project file, expanding simple conditions in it, parsing property values, assembly references and references to other projects.
/// </summary>
public class CsProjectInfo
{
/// <summary>
/// Evaluated properties from the project file
/// </summary>
public Dictionary<string, string> Properties;
/// <summary>
/// Mapping of referenced assemblies to their 'CopyLocal' (aka 'Private') setting.
/// </summary>
public Dictionary<FileReference, bool> References = new Dictionary<FileReference, bool>();
/// <summary>
/// Mapping of referenced projects to their 'CopyLocal' (aka 'Private') setting.
/// </summary>
public Dictionary<FileReference, bool> ProjectReferences = new Dictionary<FileReference, bool>();
/// <summary>
/// Mapping of content IF they are flagged Always or Newer
/// </summary>
public Dictionary<FileReference, bool> ContentReferences = new Dictionary<FileReference, bool>();
/// <summary>
/// Constructor
/// </summary>
/// <param name="InProperties">Initial mapping of property names to values</param>
CsProjectInfo(Dictionary<string, string> InProperties)
{
Properties = new Dictionary<string, string>(InProperties);
}
/// <summary>
/// Resolve the project's output directory
/// </summary>
/// <param name="BaseDirectory">Base directory to resolve relative paths to</param>
/// <returns>The configured output directory</returns>
public DirectoryReference GetOutputDir(DirectoryReference BaseDirectory)
{
string OutputPath;
if (Properties.TryGetValue("OutputPath", out OutputPath))
{
return DirectoryReference.Combine(BaseDirectory, OutputPath);
}
else
{
return BaseDirectory;
}
}
/// <summary>
/// Finds all build products from this project. This includes content and other assemblies marked to be copied local.
/// </summary>
/// <param name="OutputDir">The output directory</param>
/// <param name="BuildProducts">Receives the set of build products</param>
/// <param name="ProjectFileToInfo">Map of project file to information, to resolve build products from referenced projects copied locally</param>
public void FindBuildProducts(DirectoryReference OutputDir, HashSet<FileReference> BuildProducts, Dictionary<FileReference, CsProjectInfo> ProjectFileToInfo)
{
// Add the standard build products
FindCompiledBuildProducts(OutputDir, BuildProducts);
// Add the referenced assemblies which are marked to be copied into the output directory. This only happens for the main project, and does not happen for referenced projects.
foreach(KeyValuePair<FileReference, bool> Reference in References)
{
if (Reference.Value)
{
FileReference OutputFile = FileReference.Combine(OutputDir, Reference.Key.GetFileName());
AddReferencedAssemblyAndSupportFiles(OutputFile, BuildProducts);
}
}
// Copy the build products for any referenced projects. Note that this does NOT operate recursively.
foreach(KeyValuePair<FileReference, bool> ProjectReference in ProjectReferences)
{
CsProjectInfo OtherProjectInfo;
if(ProjectFileToInfo.TryGetValue(ProjectReference.Key, out OtherProjectInfo))
{
OtherProjectInfo.FindCompiledBuildProducts(OutputDir, BuildProducts);
}
}
// Add any copied content. This DOES operate recursively.
FindCopiedContent(OutputDir, BuildProducts, ProjectFileToInfo);
}
/// <summary>
/// Determines all the compiled build products (executable, etc...) directly built from this project.
/// </summary>
/// <param name="OutputDir">The output directory</param>
/// <param name="BuildProducts">Receives the set of build products</param>
public void FindCompiledBuildProducts(DirectoryReference OutputDir, HashSet<FileReference> BuildProducts)
{
string OutputType, AssemblyName;
if (Properties.TryGetValue("OutputType", out OutputType) && Properties.TryGetValue("AssemblyName", out AssemblyName))
{
// DotNET Core framework doesn't produce .exe files, it produces DLLs in all cases
if (IsDotNETCoreProject())
{
OutputType = "Library";
}
switch (OutputType)
{
case "Exe":
case "WinExe":
BuildProducts.Add(FileReference.Combine(OutputDir, AssemblyName + ".exe"));
AddOptionalBuildProduct(FileReference.Combine(OutputDir, AssemblyName + ".pdb"), BuildProducts);
AddOptionalBuildProduct(FileReference.Combine(OutputDir, AssemblyName + ".exe.config"), BuildProducts);
AddOptionalBuildProduct(FileReference.Combine(OutputDir, AssemblyName + ".exe.mdb"), BuildProducts);
break;
case "Library":
BuildProducts.Add(FileReference.Combine(OutputDir, AssemblyName + ".dll"));
AddOptionalBuildProduct(FileReference.Combine(OutputDir, AssemblyName + ".pdb"), BuildProducts);
AddOptionalBuildProduct(FileReference.Combine(OutputDir, AssemblyName + ".dll.config"), BuildProducts);
AddOptionalBuildProduct(FileReference.Combine(OutputDir, AssemblyName + ".dll.mdb"), BuildProducts);
break;
}
}
}
/// <summary>
/// Finds all content which will be copied into the output directory for this project. This includes content from any project references as "copy local" recursively (though MSBuild only traverses a single reference for actual binaries, in such cases)
/// </summary>
/// <param name="OutputDir">The output directory</param>
/// <param name="BuildProducts">Receives the set of build products</param>
/// <param name="ProjectFileToInfo">Map of project file to information, to resolve build products from referenced projects copied locally</param>
private void FindCopiedContent(DirectoryReference OutputDir, HashSet<FileReference> OutputFiles, Dictionary<FileReference, CsProjectInfo> ProjectFileToInfo)
{
// Copy any referenced projects too.
foreach(KeyValuePair<FileReference, bool> ProjectReference in ProjectReferences)
{
CsProjectInfo OtherProjectInfo;
if(ProjectFileToInfo.TryGetValue(ProjectReference.Key, out OtherProjectInfo))
{
OtherProjectInfo.FindCopiedContent(OutputDir, OutputFiles, ProjectFileToInfo);
}
}
// Add the content which is copied to the output directory
foreach (KeyValuePair<FileReference, bool> ContentReference in ContentReferences)
{
FileReference ContentFile = ContentReference.Key;
if (ContentReference.Value)
{
OutputFiles.Add(FileReference.Combine(OutputDir, ContentFile.GetFileName()));
}
}
}
/// <summary>
/// Adds the given file and any additional build products to the output set
/// </summary>
/// <param name="OutputFile">The assembly to add</param>
/// <param name="OutputFiles">Set to receive the file and support files</param>
static public void AddReferencedAssemblyAndSupportFiles(FileReference OutputFile, HashSet<FileReference> OutputFiles)
{
OutputFiles.Add(OutputFile);
FileReference SymbolFile = OutputFile.ChangeExtension(".pdb");
if (FileReference.Exists(SymbolFile))
{
OutputFiles.Add(SymbolFile);
}
FileReference DocumentationFile = OutputFile.ChangeExtension(".xml");
if (FileReference.Exists(DocumentationFile))
{
OutputFiles.Add(DocumentationFile);
}
}
/// <summary>
/// Determines if this project is a .NET core project
/// </summary>
/// <returns>True if the project is a .NET core project</returns>
public bool IsDotNETCoreProject()
{
bool bIsDotNetCoreProject = false;
string TargetFramework;
if (Properties.TryGetValue("TargetFramework", out TargetFramework))
{
bIsDotNetCoreProject = TargetFramework.ToLower().Contains("netstandard") || TargetFramework.ToLower().Contains("netcoreapp");
}
return bIsDotNetCoreProject;
}
/// <summary>
/// Adds a build product to the output list if it exists
/// </summary>
/// <param name="BuildProduct">The build product to add</param>
/// <param name="BuildProducts">List of output build products</param>
public static void AddOptionalBuildProduct(FileReference BuildProduct, HashSet<FileReference> BuildProducts)
{
if (FileReference.Exists(BuildProduct))
{
BuildProducts.Add(BuildProduct);
}
}
/// <summary>
/// Attempts to read project information for the given file.
/// </summary>
/// <param name="File">The project file to read</param>
/// <param name="Properties">Initial set of property values</param>
/// <param name="OutProjectInfo">If successful, the parsed project info</param>
/// <returns>True if the project was read successfully, false otherwise</returns>
public static bool TryRead(FileReference File, Dictionary<string, string> Properties, out CsProjectInfo OutProjectInfo)
{
// Read the project file
XmlDocument Document = new XmlDocument();
Document.Load(File.FullName);
// Check the root element is the right type
// HashSet<FileReference> ProjectBuildProducts = new HashSet<FileReference>();
if (Document.DocumentElement.Name != "Project")
{
OutProjectInfo = null;
return false;
}
// Parse the basic structure of the document, updating properties and recursing into other referenced projects as we go
CsProjectInfo ProjectInfo = new CsProjectInfo(Properties);
foreach (XmlElement Element in Document.DocumentElement.ChildNodes.OfType<XmlElement>())
{
switch (Element.Name)
{
case "PropertyGroup":
if (EvaluateCondition(Element, ProjectInfo.Properties))
{
ParsePropertyGroup(Element, ProjectInfo.Properties);
}
break;
case "ItemGroup":
if (EvaluateCondition(Element, ProjectInfo.Properties))
{
ParseItemGroup(File.Directory, Element, ProjectInfo);
}
break;
}
}
// Return the complete project
OutProjectInfo = ProjectInfo;
return true;
}
/// <summary>
/// Parses a 'PropertyGroup' element.
/// </summary>
/// <param name="ParentElement">The parent 'PropertyGroup' element</param>
/// <param name="Properties">Dictionary mapping property names to values</param>
static void ParsePropertyGroup(XmlElement ParentElement, Dictionary<string, string> Properties)
{
// We need to know the overridden output type and output path for the selected configuration.
foreach (XmlElement Element in ParentElement.ChildNodes.OfType<XmlElement>())
{
if (EvaluateCondition(Element, Properties))
{
Properties[Element.Name] = ExpandProperties(Element.InnerText, Properties);
}
}
}
/// <summary>
/// Parses an 'ItemGroup' element.
/// </summary>
/// <param name="BaseDirectory">Base directory to resolve relative paths against</param>
/// <param name="ParentElement">The parent 'ItemGroup' element</param>
/// <param name="ProjectInfo">Project info object to be updated</param>
static void ParseItemGroup(DirectoryReference BaseDirectory, XmlElement ParentElement, CsProjectInfo ProjectInfo)
{
// Parse any external assembly references
foreach (XmlElement ItemElement in ParentElement.ChildNodes.OfType<XmlElement>())
{
switch (ItemElement.Name)
{
case "Reference":
// Reference to an external assembly
if (EvaluateCondition(ItemElement, ProjectInfo.Properties))
{
ParseReference(BaseDirectory, ItemElement, ProjectInfo.References);
}
break;
case "ProjectReference":
// Reference to another project
if (EvaluateCondition(ItemElement, ProjectInfo.Properties))
{
ParseProjectReference(BaseDirectory, ItemElement, ProjectInfo.ProjectReferences);
}
break;
case "Content":
case "None":
// Reference to another project
if (EvaluateCondition(ItemElement, ProjectInfo.Properties))
{
ParseContent(BaseDirectory, ItemElement, ProjectInfo.ContentReferences);
}
break;
}
}
}
/// <summary>
/// Parses an assembly reference from a given 'Reference' element
/// </summary>
/// <param name="BaseDirectory">Directory to resolve relative paths against</param>
/// <param name="ParentElement">The parent 'Reference' element</param>
/// <param name="References">Dictionary of project files to a bool indicating whether the assembly should be copied locally to the referencing project.</param>
static void ParseReference(DirectoryReference BaseDirectory, XmlElement ParentElement, Dictionary<FileReference, bool> References)
{
string HintPath = UnescapeString(GetChildElementString(ParentElement, "HintPath", null));
if (!String.IsNullOrEmpty(HintPath))
{
// Don't include embedded assemblies; they aren't referenced externally by the compiled executable
bool bEmbedInteropTypes = GetChildElementBoolean(ParentElement, "EmbedInteropTypes", false);
if(!bEmbedInteropTypes)
{
FileReference AssemblyFile = FileReference.Combine(BaseDirectory, HintPath);
bool bPrivate = GetChildElementBoolean(ParentElement, "Private", !bEmbedInteropTypes);
References.Add(AssemblyFile, bPrivate);
}
}
}
/// <summary>
/// Parses a project reference from a given 'ProjectReference' element
/// </summary>
/// <param name="BaseDirectory">Directory to resolve relative paths against</param>
/// <param name="ParentElement">The parent 'ProjectReference' element</param>
/// <param name="ProjectReferences">Dictionary of project files to a bool indicating whether the outputs of the project should be copied locally to the referencing project.</param>
static void ParseProjectReference(DirectoryReference BaseDirectory, XmlElement ParentElement, Dictionary<FileReference, bool> ProjectReferences)
{
string IncludePath = UnescapeString(ParentElement.GetAttribute("Include"));
if (!String.IsNullOrEmpty(IncludePath))
{
FileReference ProjectFile = FileReference.Combine(BaseDirectory, IncludePath);
bool bPrivate = GetChildElementBoolean(ParentElement, "Private", true);
ProjectReferences[ProjectFile] = bPrivate;
}
}
/// <summary>
/// Parses an assembly reference from a given 'Content' element
/// </summary>
/// <param name="BaseDirectory">Directory to resolve relative paths against</param>
/// <param name="ParentElement">The parent 'Content' element</param>
/// <param name="Contents">Dictionary of project files to a bool indicating whether the assembly should be copied locally to the referencing project.</param>
static void ParseContent(DirectoryReference BaseDirectory, XmlElement ParentElement, Dictionary<FileReference, bool> Contents)
{
string IncludePath = UnescapeString(ParentElement.GetAttribute("Include"));
if (!String.IsNullOrEmpty(IncludePath))
{
string CopyTo = GetChildElementString(ParentElement, "CopyToOutputDirectory", null);
bool ShouldCopy = !String.IsNullOrEmpty(CopyTo) && (CopyTo.Equals("Always", StringComparison.InvariantCultureIgnoreCase) || CopyTo.Equals("PreserveNewest", StringComparison.InvariantCultureIgnoreCase));
FileReference ContentFile = FileReference.Combine(BaseDirectory, IncludePath);
Contents.Add(ContentFile, ShouldCopy);
}
}
/// <summary>
/// Reads the inner text of a child XML element
/// </summary>
/// <param name="ParentElement">The parent element to check</param>
/// <param name="Name">Name of the child element</param>
/// <param name="DefaultValue">Default value to return if the child element is missing</param>
/// <returns>The contents of the child element, or default value if it's not present</returns>
static string GetChildElementString(XmlElement ParentElement, string Name, string DefaultValue)
{
XmlElement ChildElement = ParentElement.ChildNodes.OfType<XmlElement>().FirstOrDefault(x => x.Name == Name);
if (ChildElement == null)
{
return DefaultValue;
}
else
{
return ChildElement.InnerText ?? DefaultValue;
}
}
/// <summary>
/// Read a child XML element with the given name, and parse it as a boolean.
/// </summary>
/// <param name="ParentElement">Parent element to check</param>
/// <param name="Name">Name of the child element to look for</param>
/// <param name="DefaultValue">Default value to return if the element is missing or not a valid bool</param>
/// <returns>The parsed boolean, or the default value</returns>
static bool GetChildElementBoolean(XmlElement ParentElement, string Name, bool DefaultValue)
{
string Value = GetChildElementString(ParentElement, Name, null);
if (Value == null)
{
return DefaultValue;
}
else if (Value.Equals("True", StringComparison.InvariantCultureIgnoreCase))
{
return true;
}
else if (Value.Equals("False", StringComparison.InvariantCultureIgnoreCase))
{
return false;
}
else
{
return DefaultValue;
}
}
/// <summary>
/// Evaluate whether the optional MSBuild condition on an XML element evaluates to true. Currently only supports 'ABC' == 'DEF' style expressions, but can be expanded as needed.
/// </summary>
/// <param name="Element">The XML element to check</param>
/// <param name="Properties">Dictionary mapping from property names to values.</param>
/// <returns></returns>
static bool EvaluateCondition(XmlElement Element, Dictionary<string, string> Properties)
{
// Read the condition attribute. If it's not present, assume it evaluates to true.
string Condition = Element.GetAttribute("Condition");
if (String.IsNullOrEmpty(Condition))
{
return true;
}
// Expand all the properties
Condition = ExpandProperties(Condition, Properties);
// Parse literal true/false values
bool OutResult;
if (bool.TryParse(Condition, out OutResult))
{
return OutResult;
}
// Tokenize the condition
string[] Tokens = Tokenize(Condition);
// Try to evaluate it. We only support a very limited class of condition expressions at the moment, but it's enough to parse standard projects
bool bResult;
if (Tokens.Length == 3 && Tokens[0].StartsWith("'") && Tokens[1] == "==" && Tokens[2].StartsWith("'"))
{
bResult = String.Compare(Tokens[0], Tokens[2], StringComparison.InvariantCultureIgnoreCase) == 0;
}
else if (Tokens.Length == 3 && Tokens[0].StartsWith("'") && Tokens[1] == "!=" && Tokens[2].StartsWith("'"))
{
bResult = String.Compare(Tokens[0], Tokens[2], StringComparison.InvariantCultureIgnoreCase) != 0;
}
else
{
throw new Exception("Couldn't parse condition in project file");
}
return bResult;
}
/// <summary>
/// Expand MSBuild properties within a string. If referenced properties are not in this dictionary, the process' environment variables are expanded. Unknown properties are expanded to an empty string.
/// </summary>
/// <param name="Text">The input string to expand</param>
/// <param name="Properties">Dictionary mapping from property names to values.</param>
/// <returns>String with all properties expanded.</returns>
static string ExpandProperties(string Text, Dictionary<string, string> Properties)
{
string NewText = Text;
for (int Idx = NewText.IndexOf("$("); Idx != -1; Idx = NewText.IndexOf("$(", Idx))
{
// Find the end of the variable name, accounting for changes in scope
int EndIdx = Idx + 2;
for(int Depth = 1; Depth > 0; EndIdx++)
{
if(EndIdx == NewText.Length)
{
throw new Exception("Encountered end of string while expanding properties");
}
else if(NewText[EndIdx] == '(')
{
Depth++;
}
else if(NewText[EndIdx] == ')')
{
Depth--;
}
}
// Convert the property name to tokens
string[] Tokens = Tokenize(NewText.Substring(Idx + 2, (EndIdx - 1) - (Idx + 2)));
// Make sure the first token is a valid property name
if(Tokens.Length == 0 || !(Char.IsLetter(Tokens[0][0]) || Tokens[0][0] == '_'))
{
throw new Exception(String.Format("Invalid property name '{0}' in .csproj file", Tokens[0]));
}
// Find the value for it, either from the dictionary or the environment block
string Value;
if (!Properties.TryGetValue(Tokens[0], out Value))
{
Value = Environment.GetEnvironmentVariable(Tokens[0]) ?? "";
}
// Evaluate any functions within it
int TokenIdx = 1;
while(TokenIdx + 3 < Tokens.Length && Tokens[TokenIdx] == "." && Tokens[TokenIdx + 2] == "(")
{
// Read the method name
string MethodName = Tokens[TokenIdx + 1];
// Skip to the first argument
TokenIdx += 3;
// Parse any arguments
List<object> Arguments = new List<object>();
if(Tokens[TokenIdx] != ")")
{
Arguments.Add(ParseArgument(Tokens[TokenIdx]));
TokenIdx++;
while(TokenIdx + 1 < Tokens.Length && Tokens[TokenIdx] == ",")
{
Arguments.Add(ParseArgument(Tokens[TokenIdx + 2]));
TokenIdx += 2;
}
if(Tokens[TokenIdx] != ")")
{
throw new Exception("Missing closing parenthesis in condition");
}
}
// Skip over the closing parenthesis
TokenIdx++;
// Execute the method
try
{
Value = typeof(string).InvokeMember(MethodName, System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.InvokeMethod, Type.DefaultBinder, Value, Arguments.ToArray()).ToString();
}
catch(Exception Ex)
{
throw new Exception(String.Format("Unable to evaluate condition '{0}'", Text), Ex);
}
}
if(TokenIdx < Tokens.Length && Tokens[TokenIdx] == ":")
{
TokenIdx = Tokens.Length;
}
// Make sure there's nothing left over
if(TokenIdx != Tokens.Length)
{
Console.WriteLine(string.Join("::", Tokens));
throw new Exception(String.Format("Unable to parse token '{0}' '{1}'", NewText, TokenIdx));
}
// Replace the variable with its value
NewText = NewText.Substring(0, Idx) + Value + NewText.Substring(EndIdx);
// Make sure we skip over the expanded variable; we don't want to recurse on it.
Idx += Value.Length;
}
return NewText;
}
/// <summary>
/// Parse an argument into a framework type
/// </summary>
/// <param name="Token">The token to parse</param>
/// <returns>The argument object</returns>
static object ParseArgument(string Token)
{
// Try to parse a string
if(Token.Length > 2 && Token[0] == '\'' && Token[Token.Length - 1] == '\'')
{
return Token.Substring(1, Token.Length - 2);
}
// Try to parse an integer
int Value;
if(int.TryParse(Token, out Value))
{
return Value;
}
// Otherwise throw an exception
throw new Exception(String.Format("Unable to parse token '{0}' into a .NET framework type", Token));
}
/// <summary>
/// Split an MSBuild condition into tokens
/// </summary>
/// <param name="Condition">The condition expression</param>
/// <returns>Array of the parsed tokens</returns>
static string[] Tokenize(string Condition)
{
List<string> Tokens = new List<string>();
for (int Idx = 0; Idx < Condition.Length; )
{
if(Char.IsWhiteSpace(Condition[Idx]))
{
// Whitespace
Idx++;
}
else if (Idx + 1 < Condition.Length && Condition[Idx] == '=' && Condition[Idx + 1] == '=')
{
// "==" operator
Idx += 2;
Tokens.Add("==");
}
else if (Idx + 1 < Condition.Length && Condition[Idx] == '!' && Condition[Idx + 1] == '=')
{
// "!=" operator
Idx += 2;
Tokens.Add("!=");
}
else if (Condition[Idx] == '\'')
{
// Quoted string
int StartIdx = Idx++;
for(;;Idx++)
{
if(Idx == Condition.Length)
{
throw new Exception(String.Format("Missing end quote in condition string ('{0}')", Condition));
}
if(Condition[Idx] == '\'')
{
break;
}
}
Idx++;
Tokens.Add(Condition.Substring(StartIdx, Idx - StartIdx));
}
else if(Char.IsLetterOrDigit(Condition[Idx]) || Condition[Idx] == '_')
{
// Identifier or number
int StartIdx = Idx++;
while(Idx < Condition.Length && (Char.IsLetterOrDigit(Condition[Idx]) || Condition[Idx] == '_'))
{
Idx++;
}
Tokens.Add(Condition.Substring(StartIdx, Idx - StartIdx));
}
else
{
// Other token; assume a single character.
string Token = Condition.Substring(Idx++, 1);
Tokens.Add(Token);
}
}
return Tokens.ToArray();
}
/// <summary>
/// Un-escape an MSBuild string (see https://msdn.microsoft.com/en-us/library/bb383819.aspx)
/// </summary>
/// <param name="Text">String to remove escape characters from</param>
/// <returns>Unescaped string</returns>
static string UnescapeString(string Text)
{
const string HexChars = "0123456789abcdef";
string NewText = Text;
if(NewText != null)
{
for(int Idx = 0; Idx + 2 < NewText.Length; Idx++)
{
if(NewText[Idx] == '%')
{
int UpperDigitIdx = HexChars.IndexOf(Char.ToLowerInvariant(NewText[Idx + 1]));
if(UpperDigitIdx != -1)
{
int LowerDigitIdx = HexChars.IndexOf(Char.ToLowerInvariant(NewText[Idx + 2]));
if(LowerDigitIdx != -1)
{
char NewChar = (char)((UpperDigitIdx << 4) | LowerDigitIdx);
NewText = NewText.Substring(0, Idx) + NewChar + NewText.Substring(Idx + 3);
}
}
}
}
}
return NewText;
}
}
}