Xamarin Public Jenkins (auto-signing) e79aa3c0ed Imported Upstream version 4.6.0.125
Former-commit-id: a2155e9bd80020e49e72e86c44da02a8ac0e57a4
2016-08-03 10:59:49 +00:00

566 lines
21 KiB
C#

//
// ProjectInstance.cs
//
// Author:
// Rolf Bjarne Kvinge (rolf@xamarin.com)
// Atsushi Enomoto (atsushi@xamarin.com)
//
// Copyright (C) 2011,2013 Xamarin Inc.
//
// 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.
//
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Build.Construction;
using Microsoft.Build.Evaluation;
using Microsoft.Build.Framework;
using Microsoft.Build.Internal.Expressions;
using Microsoft.Build.Logging;
//
// It is not always consistent to reuse Project and its evaluation stuff mostly because
// both BuildParameters.ctor() and Project.ctor() takes arbitrary ProjectCollection, which are not very likely eqivalent
// (as BuildParameters.ctor(), unlike Project.ctor(...), is known to create a new ProjectCollection instance).
//
// However, that inconsistency could happen even if you only use ProjectInstance and BuildParameters.
// They both have constructors that take ProjectCollection and there is no guarantee that the arguments are the same.
// BuildManager.Build() does not fail because of inconsistent ProjectCollection instance on .NET.
//
// Anyhow, I'm not going to instantiate Project within ProjectInstance code for another reason:
// ProjectCollection.GetLoadedProject() does not return any Project instnace for corresponding ProjectInstance
// (or I should say, ProjectRootElement for both).
using Microsoft.Build.Internal;
using System.Xml;
using Microsoft.Build.Exceptions;
using System.IO;
namespace Microsoft.Build.Execution
{
public class ProjectInstance
{
// instance members
public ProjectInstance (ProjectRootElement xml)
: this (xml, null, null, ProjectCollection.GlobalProjectCollection)
{
}
public ProjectInstance (string projectFile)
: this (projectFile, null, null, ProjectCollection.GlobalProjectCollection)
{
}
public ProjectInstance (string projectFile, IDictionary<string, string> globalProperties,
string toolsVersion)
: this (projectFile, globalProperties, toolsVersion, ProjectCollection.GlobalProjectCollection)
{
}
public ProjectInstance (ProjectRootElement xml, IDictionary<string, string> globalProperties,
string toolsVersion, ProjectCollection projectCollection)
{
projects = projectCollection;
global_properties = globalProperties ?? new Dictionary<string, string> ();
tools_version = !string.IsNullOrEmpty (toolsVersion) ? toolsVersion :
!string.IsNullOrEmpty (xml.ToolsVersion) ? xml.ToolsVersion :
projects.DefaultToolsVersion;
InitializeProperties (xml);
}
public ProjectInstance (string projectFile, IDictionary<string, string> globalProperties,
string toolsVersion, ProjectCollection projectCollection)
: this (ProjectRootElement.Create (projectFile), globalProperties, toolsVersion, projectCollection)
{
}
ProjectCollection projects;
IDictionary<string, string> global_properties;
string full_path, directory;
ElementLocation location;
Dictionary<string, ProjectItemDefinitionInstance> item_definitions;
List<ResolvedImport> raw_imports; // maybe we don't need this...
List<ProjectItemInstance> all_evaluated_items;
List<ProjectItemInstance> raw_items;
Dictionary<string,ProjectPropertyInstance> properties;
Dictionary<string, ProjectTargetInstance> targets;
string tools_version;
// FIXME: this is a duplicate code between Project and ProjectInstance
string [] GetDefaultTargets (ProjectRootElement xml)
{
var ret = GetDefaultTargets (xml, true, true);
return ret.Any () ? ret : GetDefaultTargets (xml, false, true);
}
string [] GetDefaultTargets (ProjectRootElement xml, bool fromAttribute, bool checkImports)
{
if (fromAttribute) {
var ret = xml.DefaultTargets.Split (item_target_sep, StringSplitOptions.RemoveEmptyEntries).Select (s => s.Trim ()).ToArray ();
if (checkImports && ret.Length == 0) {
foreach (var imp in this.raw_imports) {
ret = GetDefaultTargets (imp.ImportedProject, true, false);
if (ret.Any ())
break;
}
}
return ret;
} else {
if (xml.Targets.Any ())
return new String [] { xml.Targets.First ().Name };
if (checkImports) {
foreach (var imp in this.raw_imports) {
var ret = GetDefaultTargets (imp.ImportedProject, false, false);
if (ret.Any ())
return ret;
}
}
return new string [0];
}
}
void InitializeProperties (ProjectRootElement xml)
{
location = xml.Location;
full_path = xml.FullPath;
directory = string.IsNullOrWhiteSpace (xml.DirectoryPath) ? System.IO.Directory.GetCurrentDirectory () : xml.DirectoryPath;
InitialTargets = xml.InitialTargets.Split (item_target_sep, StringSplitOptions.RemoveEmptyEntries).Select (s => s.Trim ()).ToList ();
raw_imports = new List<ResolvedImport> ();
item_definitions = new Dictionary<string, ProjectItemDefinitionInstance> ();
targets = new Dictionary<string, ProjectTargetInstance> ();
raw_items = new List<ProjectItemInstance> ();
properties = new Dictionary<string,ProjectPropertyInstance> ();
foreach (DictionaryEntry p in Environment.GetEnvironmentVariables ())
// FIXME: this is kind of workaround for unavoidable issue that PLATFORM=* is actually given
// on some platforms and that prevents setting default "PLATFORM=AnyCPU" property.
if (!string.Equals ("PLATFORM", (string) p.Key, StringComparison.OrdinalIgnoreCase))
this.properties [(string) p.Key] = new ProjectPropertyInstance ((string) p.Key, true, (string) p.Value);
foreach (var p in global_properties)
this.properties [p.Key] = new ProjectPropertyInstance (p.Key, false, p.Value);
var tools = projects.GetToolset (tools_version) ?? projects.GetToolset (projects.DefaultToolsVersion);
foreach (var p in projects.GetReservedProperties (tools, this, xml))
this.properties [p.Name] = p;
foreach (var p in ProjectCollection.GetWellKnownProperties (this))
this.properties [p.Name] = p;
ProcessXml (xml);
DefaultTargets = GetDefaultTargets (xml).ToList ();
}
static readonly char [] item_target_sep = {';'};
void ProcessXml (ProjectRootElement xml)
{
UsingTasks = new List<ProjectUsingTaskElement> ();
// this needs to be initialized here (regardless of that items won't be evaluated at property evaluation;
// Conditions could incorrectly reference items and lack of this list causes NRE.
all_evaluated_items = new List<ProjectItemInstance> ();
// property evaluation happens couple of times.
// At first step, all non-imported properties are evaluated TOO, WHILE those properties are being evaluated.
// This means, Include and IncludeGroup elements with Condition attribute MAY contain references to
// properties and they will be expanded.
var elements = EvaluatePropertiesAndUsingTasksAndImportsAndChooses (xml.Children).ToArray (); // ToArray(): to not lazily evaluate elements.
// next, evaluate items
EvaluateItems (xml, elements);
// finally, evaluate targets and tasks
EvaluateTargets (elements);
}
IEnumerable<ProjectElement> EvaluatePropertiesAndUsingTasksAndImportsAndChooses (IEnumerable<ProjectElement> elements)
{
foreach (var child in elements) {
yield return child;
var ute = child as ProjectUsingTaskElement;
if (ute != null && EvaluateCondition (ute.Condition))
UsingTasks.Add (ute);
var pge = child as ProjectPropertyGroupElement;
if (pge != null && EvaluateCondition (pge.Condition))
foreach (var p in pge.Properties)
// do not allow overwriting reserved or well-known properties by user
if (!this.properties.Any (_ => (_.Value.IsImmutable) && _.Key.Equals (p.Name, StringComparison.InvariantCultureIgnoreCase)))
if (EvaluateCondition (p.Condition))
this.properties [p.Name] = new ProjectPropertyInstance (p.Name, false, ExpandString (p.Value));
var ige = child as ProjectImportGroupElement;
if (ige != null && EvaluateCondition (ige.Condition)) {
foreach (var incc in ige.Imports) {
if (EvaluateCondition (incc.Condition))
foreach (var e in Import (incc))
yield return e;
}
}
var inc = child as ProjectImportElement;
if (inc != null && EvaluateCondition (inc.Condition))
foreach (var e in Import (inc))
yield return e;
var choose = child as ProjectChooseElement;
if (choose != null && EvaluateCondition (choose.Condition)) {
bool done = false;
foreach (ProjectWhenElement when in choose.WhenElements)
if (EvaluateCondition (when.Condition)) {
foreach (var e in EvaluatePropertiesAndUsingTasksAndImportsAndChooses (when.Children))
yield return e;
done = true;
break;
}
if (!done && choose.OtherwiseElement != null)
foreach (var e in EvaluatePropertiesAndUsingTasksAndImportsAndChooses (choose.OtherwiseElement.Children))
yield return e;
}
}
}
internal IEnumerable<T> GetAllItems<T> (string include, string exclude, Func<string,T> creator, Func<string,ITaskItem> taskItemCreator, Func<string,bool> itemTypeCheck, Action<T,string> assignRecurse)
{
return ProjectCollection.GetAllItems<T> (ExpandString, include, exclude, creator, taskItemCreator, Directory, assignRecurse,
t => all_evaluated_items.Any (i => i.EvaluatedInclude == t.ItemSpec && itemTypeCheck (i.ItemType)));
}
void EvaluateItems (ProjectRootElement xml, IEnumerable<ProjectElement> elements)
{
foreach (var child in elements.Reverse ()) {
var ige = child as ProjectItemGroupElement;
if (ige != null) {
foreach (var p in ige.Items) {
if (!EvaluateCondition (ige.Condition) || !EvaluateCondition (p.Condition))
continue;
Func<string,ProjectItemInstance> creator = s => new ProjectItemInstance (this, p.ItemType, p.Metadata.Select (m => new KeyValuePair<string,string> (m.Name, m.Value)).ToList (), s);
foreach (var item in GetAllItems (p.Include, p.Exclude, creator, s => new ProjectTaskItem (p, s), it => string.Equals (it, p.ItemType, StringComparison.OrdinalIgnoreCase), (t, s) => t.RecursiveDir = s)) {
raw_items.Add (item);
all_evaluated_items.Add (item);
}
}
}
var def = child as ProjectItemDefinitionGroupElement;
if (def != null) {
foreach (var p in def.ItemDefinitions) {
if (EvaluateCondition (p.Condition)) {
ProjectItemDefinitionInstance existing;
if (!item_definitions.TryGetValue (p.ItemType, out existing))
item_definitions.Add (p.ItemType, (existing = new ProjectItemDefinitionInstance (p)));
existing.AddItems (p);
}
}
}
}
all_evaluated_items.Sort ((p1, p2) => string.Compare (p1.ItemType, p2.ItemType, StringComparison.OrdinalIgnoreCase));
}
void EvaluateTargets (IEnumerable<ProjectElement> elements)
{
foreach (var child in elements) {
var te = child as ProjectTargetElement;
if (te != null)
// It overwrites same name target.
this.targets [te.Name] = new ProjectTargetInstance (te);
}
}
IEnumerable<ProjectElement> Import (ProjectImportElement import)
{
string dir = projects.GetEvaluationTimeThisFileDirectory (() => FullPath);
// FIXME: use appropriate logger (but cannot be instantiated here...?)
string path = ProjectCollection.FindFileInSeveralExtensionsPath (ref extensions_path_override, ExpandString, import.Project, TextWriter.Null.WriteLine);
path = Path.IsPathRooted (path) ? path : dir != null ? Path.Combine (dir, path) : Path.GetFullPath (path);
if (projects.OngoingImports.Contains (path))
throw new InvalidProjectFileException (import.Location, null, string.Format ("Circular imports was detected: {0} is already on \"importing\" stack", path));
projects.OngoingImports.Push (path);
try {
using (var reader = XmlReader.Create (path)) {
var root = ProjectRootElement.Create (reader, projects);
raw_imports.Add (new ResolvedImport (import, root, true));
return this.EvaluatePropertiesAndUsingTasksAndImportsAndChooses (root.Children).ToArray ();
}
} finally {
projects.OngoingImports.Pop ();
}
}
internal IEnumerable<ProjectItemInstance> AllEvaluatedItems {
get { return all_evaluated_items; }
}
public List<string> DefaultTargets { get; private set; }
public string Directory {
get { return directory; }
}
public string FullPath {
get { return full_path; }
}
public IDictionary<string, string> GlobalProperties {
get { return global_properties; }
}
public List<string> InitialTargets { get; private set; }
public bool IsImmutable {
get { throw new NotImplementedException (); }
}
public IDictionary<string, ProjectItemDefinitionInstance> ItemDefinitions {
get { return item_definitions; }
}
public ICollection<ProjectItemInstance> Items {
get { return all_evaluated_items; }
}
public ICollection<string> ItemTypes {
get { return all_evaluated_items.Select (i => i.ItemType).Distinct ().ToArray (); }
}
public ElementLocation ProjectFileLocation {
get { return location; }
}
public ICollection<ProjectPropertyInstance> Properties {
get { return properties.Values; }
}
public
IDictionary<string, ProjectTargetInstance> Targets {
get { return targets; }
}
public string ToolsVersion {
get { return tools_version; }
}
public ProjectItemInstance AddItem (string itemType, string evaluatedInclude)
{
return AddItem (itemType, evaluatedInclude, new KeyValuePair<string, string> [0]);
}
public ProjectItemInstance AddItem (string itemType, string evaluatedInclude, IEnumerable<KeyValuePair<string, string>> metadata)
{
var item = new ProjectItemInstance (this, itemType, metadata, evaluatedInclude);
raw_items.Add (item);
all_evaluated_items.Add (item);
return item;
}
public bool Build ()
{
return Build (new ILogger [0]);
}
public bool Build (IEnumerable<ILogger> loggers)
{
return Build (loggers, new ForwardingLoggerRecord [0]);
}
public bool Build (IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
{
return Build (DefaultTargets.ToArray (), loggers, remoteLoggers);
}
public bool Build (string target, IEnumerable<ILogger> loggers)
{
return Build (target, loggers, new ForwardingLoggerRecord [0]);
}
public bool Build (string [] targets, IEnumerable<ILogger> loggers)
{
return Build (targets, loggers, new ForwardingLoggerRecord [0]);
}
public bool Build (string target, IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
{
return Build (new string [] {target}, loggers, remoteLoggers);
}
public bool Build (string [] targets, IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
{
IDictionary<string, TargetResult> outputs;
return Build (targets, loggers, remoteLoggers, out outputs);
}
public bool Build (string[] targets, IEnumerable<ILogger> loggers, out IDictionary<string, TargetResult> targetOutputs)
{
return Build (targets, loggers, new ForwardingLoggerRecord [0], out targetOutputs);
}
public bool Build (string[] targets, IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers, out IDictionary<string, TargetResult> targetOutputs)
{
var manager = new BuildManager ();
var parameters = new BuildParameters (projects) {
ForwardingLoggers = remoteLoggers,
Loggers = loggers,
DefaultToolsVersion = projects.DefaultToolsVersion,
};
var requestData = new BuildRequestData (this, targets ?? DefaultTargets.ToArray ());
var result = manager.Build (parameters, requestData);
manager.Dispose ();
targetOutputs = result.ResultsByTarget;
return result.OverallResult == BuildResultCode.Success;
}
public ProjectInstance DeepCopy ()
{
return DeepCopy (false);
}
public ProjectInstance DeepCopy (bool isImmutable)
{
throw new NotImplementedException ();
}
public bool EvaluateCondition (string condition)
{
return string.IsNullOrWhiteSpace (condition) || new ExpressionEvaluator (this).EvaluateAsBoolean (condition);
}
public string ExpandString (string unexpandedValue)
{
return WindowsCompatibilityExtensions.NormalizeFilePath (new ExpressionEvaluator (this).Evaluate (unexpandedValue));
}
internal string ExpandString (ExpressionEvaluator evaluator, string unexpandedValue)
{
return WindowsCompatibilityExtensions.NormalizeFilePath (evaluator.Evaluate (unexpandedValue));
}
public ICollection<ProjectItemInstance> GetItems (string itemType)
{
return new CollectionFromEnumerable<ProjectItemInstance> (Items.Where (p => p.ItemType.Equals (itemType, StringComparison.OrdinalIgnoreCase)));
}
public IEnumerable<ProjectItemInstance> GetItemsByItemTypeAndEvaluatedInclude (string itemType, string evaluatedInclude)
{
throw new NotImplementedException ();
}
string extensions_path_override;
public ProjectPropertyInstance GetProperty (string name)
{
if (extensions_path_override != null && (name.Equals ("MSBuildExtensionsPath") || name.Equals ("MSBuildExtensionsPath32") || name.Equals ("MSBuildExtensionsPath64")))
return new ProjectPropertyInstance (name, true, extensions_path_override);
return properties.Values.FirstOrDefault (p => p.Name.Equals (name, StringComparison.OrdinalIgnoreCase));
}
public string GetPropertyValue (string name)
{
var prop = GetProperty (name);
return prop != null ? prop.EvaluatedValue : string.Empty;
}
public bool RemoveItem (ProjectItemInstance item)
{
// yeah, this raw_items should vanish...
raw_items.Remove (item);
return all_evaluated_items.Remove (item);
}
public bool RemoveProperty (string name)
{
var removed = properties.Values.FirstOrDefault (p => p.Name.Equals (name, StringComparison.OrdinalIgnoreCase));
if (removed == null)
return false;
properties.Remove (name);
return true;
}
public ProjectPropertyInstance SetProperty (string name, string evaluatedValue)
{
var p = new ProjectPropertyInstance (name, false, evaluatedValue);
properties [p.Name] = p;
return p;
}
public ProjectRootElement ToProjectRootElement ()
{
throw new NotImplementedException ();
}
public void UpdateStateFrom (ProjectInstance projectState)
{
throw new NotImplementedException ();
}
// static members
public static string GetEvaluatedItemIncludeEscaped (ProjectItemDefinitionInstance item)
{
// ?? ItemDefinition does not have Include attribute. What's the point here?
throw new NotImplementedException ();
}
public static string GetEvaluatedItemIncludeEscaped (ProjectItemInstance item)
{
return ProjectCollection.Escape (item.EvaluatedInclude);
}
public static string GetMetadataValueEscaped (ProjectMetadataInstance metadatum)
{
return ProjectCollection.Escape (metadatum.EvaluatedValue);
}
public static string GetMetadataValueEscaped (ProjectItemDefinitionInstance item, string name)
{
var md = item.Metadata.FirstOrDefault (m => m.Name.Equals (name, StringComparison.OrdinalIgnoreCase));
return md != null ? ProjectCollection.Escape (md.EvaluatedValue) : null;
}
public static string GetMetadataValueEscaped (ProjectItemInstance item, string name)
{
var md = item.Metadata.FirstOrDefault (m => m.Name.Equals (name, StringComparison.OrdinalIgnoreCase));
return md != null ? ProjectCollection.Escape (md.EvaluatedValue) : null;
}
public static string GetPropertyValueEscaped (ProjectPropertyInstance property)
{
// WTF happens here.
//return ProjectCollection.Escape (property.EvaluatedValue);
return property.EvaluatedValue;
}
internal List<ProjectUsingTaskElement> UsingTasks { get; private set; }
internal string GetFullPath (string pathRelativeToProject)
{
if (Path.IsPathRooted (pathRelativeToProject))
return pathRelativeToProject;
return Path.GetFullPath (Path.Combine (Directory, pathRelativeToProject));
}
}
}