Merge pull request #820 from brendanzagaeski/master
[mono.git] / mcs / class / Microsoft.Build / Microsoft.Build.Evaluation / Project.cs
index c73083b9e7b7549b1fe0986e1ea986986fa31f0f..7f2e9b29d4d22e2b5655a6da34a9e7c6236a6b0c 100644 (file)
@@ -41,9 +41,36 @@ using Microsoft.Build.Exceptions;
 using Microsoft.Build.Execution;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Internal;
+using Microsoft.Build.Internal.Expressions;
 using Microsoft.Build.Logging;
 using System.Collections;
 
+// Basically there are two semantic Project object models and their relationship is not obvious
+// (apart from Microsoft.Build.Construction.ProjectRootElement which is a "construction rule").
+//
+// Microsoft.Build.Evaluation.Project holds some "editable" project model, and it supports
+// detailed loader API (such as Items and AllEvaluatedItems).
+// ProjectPoperty holds UnevaluatedValue and gives EvaluatedValue too.
+//
+// Microsoft.Build.Execution.ProjectInstance holds "snapshot" of a project, and it lacks
+// detailed loader API. It does not give us Unevaluated property value.
+// On the other hand, it supports Targets object model. What Microsoft.Build.Evaluation.Project
+// offers there is actually a list of Microsoft.Build.Execution.ProjectInstance objects.
+// It should be also noted that only ProjectInstance has Evaluate() method (Project doesn't).
+//
+// And both API holds different set of descendant types for each and cannot really share the
+// loader code. That is lame.
+//
+// So, can either of them be used to construct the other model? Both API models share the same
+// "governor", which is Microsoft.Build.Evaluation.ProjectCollection/ Project is added to
+// its LoadedProjects list, while ProjectInstance isn't. Project cannot be loaded to load
+// a ProjectInstance, at least within the same ProjectCollection.
+//
+// On the other hand, can ProjectInstance be used to load a Project? Maybe. Since Project and
+// its descendants need Microsoft.Build.Construction.ProjectElement family as its API model
+// is part of the public API. Then I still have to understand how those AllEvaluatedItems/
+// AllEvaluatedProperties members make sense. EvaluationCounter is another propery in question.
+
 namespace Microsoft.Build.Evaluation
 {
        [DebuggerDisplay ("{FullPath} EffectiveToolsVersion={ToolsVersion} #GlobalProperties="
@@ -157,7 +184,6 @@ namespace Microsoft.Build.Evaluation
                List<ResolvedImport> raw_imports;
                List<ProjectItem> raw_items;
                List<ProjectItem> all_evaluated_items;
-               List<string> item_types;
                List<ProjectProperty> properties;
                Dictionary<string, ProjectTargetInstance> targets;
 
@@ -166,7 +192,6 @@ namespace Microsoft.Build.Evaluation
                        dir_path = Directory.GetCurrentDirectory ();
                        raw_imports = new List<ResolvedImport> ();
                        item_definitions = new Dictionary<string, ProjectItemDefinition> ();
-                       item_types = new List<string> ();
                        targets = new Dictionary<string, ProjectTargetInstance> ();
                        raw_items = new List<ProjectItem> ();
                        
@@ -177,21 +202,24 @@ namespace Microsoft.Build.Evaluation
                                properties = new List<ProjectProperty> ();
                        
                                foreach (DictionaryEntry p in Environment.GetEnvironmentVariables ())
-                                       this.properties.Add (new EnvironmentProjectProperty (this, (string)p.Key, (string)p.Value));
+                                       // 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.Add (new EnvironmentProjectProperty (this, (string)p.Key, (string)p.Value));
                                foreach (var p in GlobalProperties)
                                        this.properties.Add (new GlobalProjectProperty (this, p.Key, p.Value));
                                var tools = ProjectCollection.GetToolset (this.ToolsVersion) ?? ProjectCollection.GetToolset (this.ProjectCollection.DefaultToolsVersion);
-                               foreach (var p in ReservedProjectProperty.GetReservedProperties (tools, this))
+                               foreach (var p in ProjectCollection.GetReservedProperties (tools, this))
                                        this.properties.Add (p);
-                               foreach (var p in EnvironmentProjectProperty.GetWellKnownProperties (this))
+                               foreach (var p in ProjectCollection.GetWellKnownProperties (this))
                                        this.properties.Add (p);
                        }
 
                        ProcessXml (parent);
+                       
+                       ProjectCollection.AddProject (this);
                }
                
-               static readonly char [] item_sep = {';'};
-               
                void ProcessXml (Project parent)
                {
                        // this needs to be initialized here (regardless of that items won't be evaluated at property evaluation;
@@ -206,6 +234,9 @@ namespace Microsoft.Build.Evaluation
                        
                        // next, evaluate items
                        EvaluateItems (elements);
+                       
+                       // finally, evaluate targets and tasks
+                       EvaluateTargets (elements);
                }
                
                IEnumerable<ProjectElement> EvaluatePropertiesAndImports (IEnumerable<ProjectElement> elements)
@@ -214,26 +245,33 @@ namespace Microsoft.Build.Evaluation
                        foreach (var child in elements) {
                                yield return child;
                                var pge = child as ProjectPropertyGroupElement;
-                               if (pge != null && ShouldInclude (pge.Condition))
+                               if (pge != null && Evaluate (pge.Condition))
                                        foreach (var p in pge.Properties)
                                                // do not allow overwriting reserved or well-known properties by user
                                                if (!this.properties.Any (_ => (_.IsReservedProperty || _.IsWellKnownProperty) && _.Name.Equals (p.Name, StringComparison.InvariantCultureIgnoreCase)))
-                                                       if (ShouldInclude (p.Condition))
+                                                       if (Evaluate (p.Condition))
                                                                this.properties.Add (new XmlProjectProperty (this, p, PropertyType.Normal, ProjectCollection.OngoingImports.Any ()));
 
                                var ige = child as ProjectImportGroupElement;
-                               if (ige != null && ShouldInclude (ige.Condition)) {
+                               if (ige != null && Evaluate (ige.Condition)) {
                                        foreach (var incc in ige.Imports) {
-                                               foreach (var e in Import (incc))
-                                                       yield return e;
+                                               if (Evaluate (incc.Condition))
+                                                       foreach (var e in Import (incc))
+                                                               yield return e;
                                        }
                                }
                                var inc = child as ProjectImportElement;
-                               if (inc != null && ShouldInclude (inc.Condition))
+                               if (inc != null && Evaluate (inc.Condition))
                                        foreach (var e in Import (inc))
                                                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, DirectoryPath, assignRecurse,
+                               t => all_evaluated_items.Any (i => i.EvaluatedInclude == t.ItemSpec && itemTypeCheck (i.ItemType)));
+               }
 
                void EvaluateItems (IEnumerable<ProjectElement> elements)
                {
@@ -241,38 +279,19 @@ namespace Microsoft.Build.Evaluation
                                var ige = child as ProjectItemGroupElement;
                                if (ige != null) {
                                        foreach (var p in ige.Items) {
-                                               if (!ShouldInclude (ige.Condition) || !ShouldInclude (p.Condition))
+                                               if (!Evaluate (ige.Condition) || !Evaluate (p.Condition))
                                                        continue;
-                                               var includes = ExpandString (p.Include).Split (item_sep, StringSplitOptions.RemoveEmptyEntries);
-                                               var excludes = ExpandString (p.Exclude).Split (item_sep, StringSplitOptions.RemoveEmptyEntries);
-                                               
-                                               if (includes.Length == 0)
-                                                       continue;                                               
-                                               if (includes.Length == 1 && includes [0].IndexOf ('*') < 0 && excludes.Length == 0) {
-                                                       // for most case - shortcut.
-                                                       var item = new ProjectItem (this, p, includes [0]);
-                                                       this.raw_items.Add (item);
+                                               Func<string,ProjectItem> creator = s => new ProjectItem (this, p, s);
+                                               foreach (var item in GetAllItems<ProjectItem> (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);
-                                               } else {
-                                                       var ds = new Microsoft.Build.BuildEngine.DirectoryScanner () {
-                                                               BaseDirectory = new DirectoryInfo (DirectoryPath),
-                                                               Includes = includes.Select (i => new ProjectTaskItem (p, i)).ToArray (),
-                                                               Excludes = excludes.Select (i => new ProjectTaskItem (p, i)).ToArray (),
-                                                       };
-                                                       ds.Scan ();
-                                                       foreach (var taskItem in ds.MatchedItems) {
-                                                               // FIXME: this "each" path could still be wildcard that needs to be expanded.
-                                                               var item = new ProjectItem (this, p, taskItem.ItemSpec);
-                                                               this.raw_items.Add (item);
-                                                               all_evaluated_items.Add (item);
-                                                       }
                                                }
                                        }
                                }
                                var def = child as ProjectItemDefinitionGroupElement;
                                if (def != null) {
                                        foreach (var p in def.ItemDefinitions) {
-                                               if (ShouldInclude (p.Condition)) {
+                                               if (Evaluate (p.Condition)) {
                                                        ProjectItemDefinition existing;
                                                        if (!item_definitions.TryGetValue (p.ItemType, out existing))
                                                                item_definitions.Add (p.ItemType, (existing = new ProjectItemDefinition (this, p.ItemType)));
@@ -284,14 +303,24 @@ namespace Microsoft.Build.Evaluation
                        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)
+                                       this.targets.Add (te.Name, new ProjectTargetInstance (te));
+                       }
+               }
+               
                IEnumerable<ProjectElement> Import (ProjectImportElement import)
                {
-                       string dir = GetEvaluationTimeThisFileDirectory ();
-                       string path = Path.IsPathRooted (import.Project) ? import.Project : dir != null ? Path.Combine (dir, import.Project) : Path.GetFullPath (import.Project);
+                       string dir = ProjectCollection.GetEvaluationTimeThisFileDirectory (() => FullPath);
+                       string path = WindowsCompatibilityExtensions.NormalizeFilePath (ExpandString (import.Project));
+                       path = Path.IsPathRooted (path) ? path : dir != null ? Path.Combine (dir, path) : Path.GetFullPath (path);
                        if (ProjectCollection.OngoingImports.Contains (path)) {
                                switch (load_settings) {
                                case ProjectLoadSettings.RejectCircularImports:
-                                       throw new InvalidProjectFileException (import.Location, null, string.Format ("Circular imports was detected: {0} is already on \"importing\" stack", path));
+                                       throw new InvalidProjectFileException (import.Location, null, string.Format ("Circular imports was detected: {0} (resolved as \"{1}\") is already on \"importing\" stack", import.Project, path));
                                }
                                return new ProjectElement [0]; // do not import circular references
                        }
@@ -348,15 +377,17 @@ namespace Microsoft.Build.Evaluation
                {
                        throw new NotImplementedException ();
                }
+               
+               static readonly char [] target_sep = new char[] {';'};
 
                public bool Build ()
                {
-                       return Build (Xml.DefaultTargets.Split (';'));
+                       return Build (Xml.DefaultTargets.Split (target_sep, StringSplitOptions.RemoveEmptyEntries));
                }
 
                public bool Build (IEnumerable<ILogger> loggers)
                {
-                       return Build (Xml.DefaultTargets.Split (';'), loggers);
+                       return Build (Xml.DefaultTargets.Split (target_sep, StringSplitOptions.RemoveEmptyEntries), loggers);
                }
 
                public bool Build (string target)
@@ -371,7 +402,7 @@ namespace Microsoft.Build.Evaluation
 
                public bool Build (ILogger logger)
                {
-                       return Build (Xml.DefaultTargets.Split (';'), new ILogger [] {logger});
+                       return Build (Xml.DefaultTargets.Split (target_sep, StringSplitOptions.RemoveEmptyEntries), new ILogger [] {logger});
                }
 
                public bool Build (string[] targets, IEnumerable<ILogger> loggers)
@@ -381,7 +412,7 @@ namespace Microsoft.Build.Evaluation
 
                public bool Build (IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
                {
-                       return Build (Xml.DefaultTargets.Split (';'), loggers, remoteLoggers);
+                       return Build (Xml.DefaultTargets.Split (target_sep, StringSplitOptions.RemoveEmptyEntries), loggers, remoteLoggers);
                }
 
                public bool Build (string target, IEnumerable<ILogger> loggers)
@@ -410,7 +441,7 @@ namespace Microsoft.Build.Evaluation
                        return ret;
                }
                
-               bool ShouldInclude (string unexpandedValue)
+               bool Evaluate (string unexpandedValue)
                {
                        return string.IsNullOrWhiteSpace (unexpandedValue) || new ExpressionEvaluator (this, null).EvaluateAsBoolean (unexpandedValue);
                }
@@ -432,6 +463,7 @@ namespace Microsoft.Build.Evaluation
 
                public static string GetEvaluatedItemIncludeEscaped (ProjectItemDefinition item)
                {
+                       // ?? ItemDefinition does not have Include attribute. What's the point here?
                        throw new NotImplementedException ();
                }
 
@@ -457,13 +489,13 @@ namespace Microsoft.Build.Evaluation
 
                public static string GetMetadataValueEscaped (ProjectItem item, string name)
                {
-                       var md = item.GetMetadata (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 (ProjectItemDefinition item, string name)
                {
-                       var md = item.Metadata.FirstOrDefault (m => m.Name == name);
+                       var md = item.Metadata.FirstOrDefault (m => m.Name.Equals (name, StringComparison.OrdinalIgnoreCase));
                        return md != null ? ProjectCollection.Escape (md.EvaluatedValue) : null;
                }
 
@@ -476,6 +508,7 @@ namespace Microsoft.Build.Evaluation
                public static string GetPropertyValueEscaped (ProjectProperty property)
                {
                        // WTF happens here.
+                       //return ProjectCollection.Escape (property.EvaluatedValue);
                        return property.EvaluatedValue;
                }
 
@@ -507,7 +540,7 @@ namespace Microsoft.Build.Evaluation
 
                public bool RemoveProperty (ProjectProperty property)
                {
-                       var removed = properties.FirstOrDefault (p => p.Name == property.Name);
+                       var removed = properties.FirstOrDefault (p => p.Name.Equals (property.Name, StringComparison.OrdinalIgnoreCase));
                        if (removed == null)
                                return false;
                        properties.Remove (removed);