5 // Leszek Ciesielski (skolima@gmail.com)
6 // Rolf Bjarne Kvinge (rolf@xamarin.com)
7 // Atsushi Enomoto (atsushi@xamarin.com)
9 // (C) 2011 Leszek Ciesielski
10 // Copyright (C) 2011,2013 Xamarin Inc. (http://www.xamarin.com)
12 // Permission is hereby granted, free of charge, to any person obtaining
13 // a copy of this software and associated documentation files (the
14 // "Software"), to deal in the Software without restriction, including
15 // without limitation the rights to use, copy, modify, merge, publish,
16 // distribute, sublicense, and/or sell copies of the Software, and to
17 // permit persons to whom the Software is furnished to do so, subject to
18 // the following conditions:
20 // The above copyright notice and this permission notice shall be
21 // included in all copies or substantial portions of the Software.
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 using System.Collections.Generic;
34 using System.Diagnostics;
39 using Microsoft.Build.Construction;
40 using Microsoft.Build.Exceptions;
41 using Microsoft.Build.Execution;
42 using Microsoft.Build.Framework;
43 using Microsoft.Build.Internal;
44 using Microsoft.Build.Logging;
45 using System.Collections;
47 namespace Microsoft.Build.Evaluation
49 [DebuggerDisplay ("{FullPath} EffectiveToolsVersion={ToolsVersion} #GlobalProperties="
50 + "{data.globalProperties.Count} #Properties={data.Properties.Count} #ItemTypes="
51 + "{data.ItemTypes.Count} #ItemDefinitions={data.ItemDefinitions.Count} #Items="
52 + "{data.Items.Count} #Targets={data.Targets.Count}")]
55 public Project (XmlReader xml)
56 : this (ProjectRootElement.Create (xml))
60 public Project (XmlReader xml, IDictionary<string, string> globalProperties,
62 : this (ProjectRootElement.Create (xml), globalProperties, toolsVersion)
66 public Project (XmlReader xml, IDictionary<string, string> globalProperties,
67 string toolsVersion, ProjectCollection projectCollection)
68 : this (ProjectRootElement.Create (xml), globalProperties, toolsVersion, projectCollection)
72 public Project (XmlReader xml, IDictionary<string, string> globalProperties,
73 string toolsVersion, ProjectCollection projectCollection,
74 ProjectLoadSettings loadSettings)
75 : this (ProjectRootElement.Create (xml), globalProperties, toolsVersion, projectCollection, loadSettings)
79 public Project (ProjectRootElement xml) : this (xml, null, null)
83 public Project (ProjectRootElement xml, IDictionary<string, string> globalProperties,
85 : this (xml, globalProperties, toolsVersion, ProjectCollection.GlobalProjectCollection)
89 public Project (ProjectRootElement xml, IDictionary<string, string> globalProperties,
90 string toolsVersion, ProjectCollection projectCollection)
91 : this (xml, globalProperties, toolsVersion, projectCollection, ProjectLoadSettings.Default)
95 public Project (ProjectRootElement xml, IDictionary<string, string> globalProperties,
96 string toolsVersion, ProjectCollection projectCollection,
97 ProjectLoadSettings loadSettings)
99 if (projectCollection == null)
100 throw new ArgumentNullException ("projectCollection");
102 this.GlobalProperties = globalProperties ?? new Dictionary<string, string> ();
103 this.ToolsVersion = toolsVersion;
104 this.ProjectCollection = projectCollection;
105 this.load_settings = loadSettings;
110 Project (ProjectRootElement imported, Project parent)
113 this.GlobalProperties = parent.GlobalProperties;
114 this.ToolsVersion = parent.ToolsVersion;
115 this.ProjectCollection = parent.ProjectCollection;
116 this.load_settings = parent.load_settings;
121 public Project (string projectFile)
122 : this (projectFile, null, null)
126 public Project (string projectFile, IDictionary<string, string> globalProperties,
128 : this (projectFile, globalProperties, toolsVersion, ProjectCollection.GlobalProjectCollection, ProjectLoadSettings.Default)
132 public Project (string projectFile, IDictionary<string, string> globalProperties,
133 string toolsVersion, ProjectCollection projectCollection)
134 : this (projectFile, globalProperties, toolsVersion, projectCollection, ProjectLoadSettings.Default)
138 public Project (string projectFile, IDictionary<string, string> globalProperties,
139 string toolsVersion, ProjectCollection projectCollection,
140 ProjectLoadSettings loadSettings)
141 : this (ProjectRootElement.Create (projectFile), globalProperties, toolsVersion, projectCollection, loadSettings)
145 ProjectLoadSettings load_settings;
147 public IDictionary<string, string> GlobalProperties { get; private set; }
149 public ProjectCollection ProjectCollection { get; private set; }
151 public string ToolsVersion { get; private set; }
153 public ProjectRootElement Xml { get; private set; }
156 Dictionary<string, ProjectItemDefinition> item_definitions;
157 List<ResolvedImport> raw_imports;
158 List<ProjectItem> raw_items;
159 List<ProjectItem> all_evaluated_items;
160 List<string> item_types;
161 List<ProjectProperty> properties;
162 Dictionary<string, ProjectTargetInstance> targets;
164 void Initialize (Project parent)
166 dir_path = Directory.GetCurrentDirectory ();
167 raw_imports = new List<ResolvedImport> ();
168 item_definitions = new Dictionary<string, ProjectItemDefinition> ();
169 item_types = new List<string> ();
170 targets = new Dictionary<string, ProjectTargetInstance> ();
171 raw_items = new List<ProjectItem> ();
173 // FIXME: this is likely hack. Test ImportedProject.Properties to see what exactly should happen.
174 if (parent != null) {
175 properties = parent.properties;
177 properties = new List<ProjectProperty> ();
179 foreach (DictionaryEntry p in Environment.GetEnvironmentVariables ())
180 this.properties.Add (new EnvironmentProjectProperty (this, (string)p.Key, (string)p.Value));
181 foreach (var p in GlobalProperties)
182 this.properties.Add (new GlobalProjectProperty (this, p.Key, p.Value));
183 var tools = ProjectCollection.GetToolset (this.ToolsVersion) ?? ProjectCollection.GetToolset (this.ProjectCollection.DefaultToolsVersion);
184 foreach (var p in ReservedProjectProperty.GetReservedProperties (tools, this))
185 this.properties.Add (p);
186 foreach (var p in EnvironmentProjectProperty.GetWellKnownProperties (this))
187 this.properties.Add (p);
193 static readonly char [] item_sep = {';'};
195 void ProcessXml (Project parent)
197 // this needs to be initialized here (regardless of that items won't be evaluated at property evaluation;
198 // Conditions could incorrectly reference items and lack of this list causes NRE.
199 all_evaluated_items = new List<ProjectItem> ();
201 // property evaluation happens couple of times.
202 // At first step, all non-imported properties are evaluated TOO, WHILE those properties are being evaluated.
203 // This means, Include and IncludeGroup elements with Condition attribute MAY contain references to
204 // properties and they will be expanded.
205 var elements = EvaluatePropertiesAndImports (Xml.Children).ToArray (); // ToArray(): to not lazily evaluate elements.
207 // next, evaluate items
208 EvaluateItems (elements);
211 IEnumerable<ProjectElement> EvaluatePropertiesAndImports (IEnumerable<ProjectElement> elements)
213 // First step: evaluate Properties
214 foreach (var child in elements) {
216 var pge = child as ProjectPropertyGroupElement;
217 if (pge != null && ShouldInclude (pge.Condition))
218 foreach (var p in pge.Properties)
219 // do not allow overwriting reserved or well-known properties by user
220 if (!this.properties.Any (_ => (_.IsReservedProperty || _.IsWellKnownProperty) && _.Name.Equals (p.Name, StringComparison.InvariantCultureIgnoreCase)))
221 if (ShouldInclude (p.Condition))
222 this.properties.Add (new XmlProjectProperty (this, p, PropertyType.Normal, ProjectCollection.OngoingImports.Any ()));
224 var ige = child as ProjectImportGroupElement;
225 if (ige != null && ShouldInclude (ige.Condition)) {
226 foreach (var incc in ige.Imports) {
227 foreach (var e in Import (incc))
231 var inc = child as ProjectImportElement;
232 if (inc != null && ShouldInclude (inc.Condition))
233 foreach (var e in Import (inc))
238 void EvaluateItems (IEnumerable<ProjectElement> elements)
240 foreach (var child in elements) {
241 var ige = child as ProjectItemGroupElement;
243 foreach (var p in ige.Items) {
244 if (!ShouldInclude (ige.Condition) || !ShouldInclude (p.Condition))
246 var includes = ExpandString (p.Include).Split (item_sep, StringSplitOptions.RemoveEmptyEntries);
247 var excludes = ExpandString (p.Exclude).Split (item_sep, StringSplitOptions.RemoveEmptyEntries);
249 if (includes.Length == 0)
251 if (includes.Length == 1 && includes [0].IndexOf ('*') < 0 && excludes.Length == 0) {
252 // for most case - shortcut.
253 var item = new ProjectItem (this, p, includes [0]);
254 this.raw_items.Add (item);
255 all_evaluated_items.Add (item);
257 var ds = new Microsoft.Build.BuildEngine.DirectoryScanner () {
258 BaseDirectory = new DirectoryInfo (DirectoryPath),
259 Includes = includes.Select (i => new ProjectTaskItem (p, i)).ToArray (),
260 Excludes = excludes.Select (i => new ProjectTaskItem (p, i)).ToArray (),
263 foreach (var taskItem in ds.MatchedItems) {
264 // FIXME: this "each" path could still be wildcard that needs to be expanded.
265 var item = new ProjectItem (this, p, taskItem.ItemSpec);
266 this.raw_items.Add (item);
267 all_evaluated_items.Add (item);
272 var def = child as ProjectItemDefinitionGroupElement;
274 foreach (var p in def.ItemDefinitions) {
275 if (ShouldInclude (p.Condition)) {
276 ProjectItemDefinition existing;
277 if (!item_definitions.TryGetValue (p.ItemType, out existing))
278 item_definitions.Add (p.ItemType, (existing = new ProjectItemDefinition (this, p.ItemType)));
279 existing.AddItems (p);
284 all_evaluated_items.Sort ((p1, p2) => string.Compare (p1.ItemType, p2.ItemType, StringComparison.OrdinalIgnoreCase));
287 IEnumerable<ProjectElement> Import (ProjectImportElement import)
289 string dir = GetEvaluationTimeThisFileDirectory ();
290 string path = Path.IsPathRooted (import.Project) ? import.Project : dir != null ? Path.Combine (dir, import.Project) : Path.GetFullPath (import.Project);
291 if (ProjectCollection.OngoingImports.Contains (path)) {
292 switch (load_settings) {
293 case ProjectLoadSettings.RejectCircularImports:
294 throw new InvalidProjectFileException (import.Location, null, string.Format ("Circular imports was detected: {0} is already on \"importing\" stack", path));
296 return new ProjectElement [0]; // do not import circular references
298 ProjectCollection.OngoingImports.Push (path);
300 using (var reader = XmlReader.Create (path)) {
301 var root = ProjectRootElement.Create (reader, ProjectCollection);
302 raw_imports.Add (new ResolvedImport (import, root, true));
303 return this.EvaluatePropertiesAndImports (root.Children).ToArray ();
306 ProjectCollection.OngoingImports.Pop ();
310 public ICollection<ProjectItem> GetItemsIgnoringCondition (string itemType)
312 return new CollectionFromEnumerable<ProjectItem> (raw_items.Where (p => p.ItemType.Equals (itemType, StringComparison.OrdinalIgnoreCase)));
315 public void RemoveItems (IEnumerable<ProjectItem> items)
317 var removal = new List<ProjectItem> (items);
318 foreach (var item in removal) {
319 var parent = item.Xml.Parent;
320 parent.RemoveChild (item.Xml);
321 if (parent.Count == 0)
322 parent.Parent.RemoveChild (parent);
326 static readonly Dictionary<string, string> empty_metadata = new Dictionary<string, string> ();
328 public IList<ProjectItem> AddItem (string itemType, string unevaluatedInclude)
330 return AddItem (itemType, unevaluatedInclude, empty_metadata);
333 public IList<ProjectItem> AddItem (string itemType, string unevaluatedInclude,
334 IEnumerable<KeyValuePair<string, string>> metadata)
336 // FIXME: needs several check that AddItemFast() does not process (see MSDN for details).
338 return AddItemFast (itemType, unevaluatedInclude, metadata);
341 public IList<ProjectItem> AddItemFast (string itemType, string unevaluatedInclude)
343 return AddItemFast (itemType, unevaluatedInclude, empty_metadata);
346 public IList<ProjectItem> AddItemFast (string itemType, string unevaluatedInclude,
347 IEnumerable<KeyValuePair<string, string>> metadata)
349 throw new NotImplementedException ();
354 return Build (Xml.DefaultTargets.Split (';'));
357 public bool Build (IEnumerable<ILogger> loggers)
359 return Build (Xml.DefaultTargets.Split (';'), loggers);
362 public bool Build (string target)
364 return string.IsNullOrWhiteSpace (target) ? Build () : Build (new string [] {target});
367 public bool Build (string[] targets)
369 return Build (targets, new ILogger [0]);
372 public bool Build (ILogger logger)
374 return Build (Xml.DefaultTargets.Split (';'), new ILogger [] {logger});
377 public bool Build (string[] targets, IEnumerable<ILogger> loggers)
379 return Build (targets, loggers, new ForwardingLoggerRecord [0]);
382 public bool Build (IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
384 return Build (Xml.DefaultTargets.Split (';'), loggers, remoteLoggers);
387 public bool Build (string target, IEnumerable<ILogger> loggers)
389 return Build (new string [] { target }, loggers);
392 public bool Build (string[] targets, IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
394 // Unlike ProjectInstance.Build(), there is no place to fill outputs by targets, so ignore them
395 // (i.e. we don't use the overload with output).
397 // This does not check FullPath, so don't call GetProjectInstanceForBuild() directly.
398 return new BuildManager ().GetProjectInstanceForBuildInternal (this).Build (targets, loggers, remoteLoggers);
401 public bool Build (string target, IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
403 return Build (new string [] { target }, loggers, remoteLoggers);
406 public ProjectInstance CreateProjectInstance ()
408 var ret = new ProjectInstance (Xml, GlobalProperties, ToolsVersion, ProjectCollection);
409 // FIXME: maybe fill other properties to the result.
413 bool ShouldInclude (string unexpandedValue)
415 return string.IsNullOrWhiteSpace (unexpandedValue) || new ExpressionEvaluator (this, null).EvaluateAsBoolean (unexpandedValue);
418 public string ExpandString (string unexpandedValue)
420 return ExpandString (unexpandedValue, null);
423 string ExpandString (string unexpandedValue, string replacementForMissingStuff)
425 return new ExpressionEvaluator (this, replacementForMissingStuff).Evaluate (unexpandedValue);
428 public static string GetEvaluatedItemIncludeEscaped (ProjectItem item)
430 return ProjectCollection.Escape (item.EvaluatedInclude);
433 public static string GetEvaluatedItemIncludeEscaped (ProjectItemDefinition item)
435 throw new NotImplementedException ();
438 public ICollection<ProjectItem> GetItems (string itemType)
440 return new CollectionFromEnumerable<ProjectItem> (Items.Where (p => p.ItemType.Equals (itemType, StringComparison.OrdinalIgnoreCase)));
443 public ICollection<ProjectItem> GetItemsByEvaluatedInclude (string evaluatedInclude)
445 return new CollectionFromEnumerable<ProjectItem> (Items.Where (p => p.EvaluatedInclude.Equals (evaluatedInclude, StringComparison.OrdinalIgnoreCase)));
448 public IEnumerable<ProjectElement> GetLogicalProject ()
450 throw new NotImplementedException ();
453 public static string GetMetadataValueEscaped (ProjectMetadata metadatum)
455 return ProjectCollection.Escape (metadatum.EvaluatedValue);
458 public static string GetMetadataValueEscaped (ProjectItem item, string name)
460 var md = item.GetMetadata (name);
461 return md != null ? ProjectCollection.Escape (md.EvaluatedValue) : null;
464 public static string GetMetadataValueEscaped (ProjectItemDefinition item, string name)
466 var md = item.Metadata.FirstOrDefault (m => m.Name == name);
467 return md != null ? ProjectCollection.Escape (md.EvaluatedValue) : null;
470 public string GetPropertyValue (string name)
472 var prop = GetProperty (name);
473 return prop != null ? prop.EvaluatedValue : string.Empty;
476 public static string GetPropertyValueEscaped (ProjectProperty property)
479 return property.EvaluatedValue;
482 public ProjectProperty GetProperty (string name)
484 return properties.FirstOrDefault (p => p.Name.Equals (name, StringComparison.OrdinalIgnoreCase));
487 public void MarkDirty ()
489 if (!DisableMarkDirty)
493 public void ReevaluateIfNecessary ()
495 throw new NotImplementedException ();
498 public bool RemoveGlobalProperty (string name)
500 throw new NotImplementedException ();
503 public bool RemoveItem (ProjectItem item)
505 throw new NotImplementedException ();
508 public bool RemoveProperty (ProjectProperty property)
510 var removed = properties.FirstOrDefault (p => p.Name == property.Name);
513 properties.Remove (removed);
522 public void Save (TextWriter writer)
527 public void Save (string path)
529 Save (path, Encoding.Default);
532 public void Save (Encoding encoding)
534 Save (FullPath, encoding);
537 public void Save (string path, Encoding encoding)
539 using (var writer = new StreamWriter (path, false, encoding))
543 public void SaveLogicalProject (TextWriter writer)
545 throw new NotImplementedException ();
548 public bool SetGlobalProperty (string name, string escapedValue)
550 throw new NotImplementedException ();
553 public ProjectProperty SetProperty (string name, string unevaluatedValue)
555 var p = new ManuallyAddedProjectProperty (this, name, unevaluatedValue);
560 public ICollection<ProjectMetadata> AllEvaluatedItemDefinitionMetadata {
561 get { throw new NotImplementedException (); }
564 public ICollection<ProjectItem> AllEvaluatedItems {
565 get { return all_evaluated_items; }
568 public ICollection<ProjectProperty> AllEvaluatedProperties {
569 get { return properties; }
572 public IDictionary<string, List<string>> ConditionedProperties {
574 // this property returns different instances every time.
575 var dic = new Dictionary<string, List<string>> ();
577 // but I dunno HOW this evaluates
579 throw new NotImplementedException ();
583 public string DirectoryPath {
584 get { return dir_path; }
587 public bool DisableMarkDirty { get; set; }
589 public int EvaluationCounter {
590 get { throw new NotImplementedException (); }
593 public string FullPath {
594 get { return Xml.FullPath; }
595 set { Xml.FullPath = value; }
598 class ResolvedImportComparer : IEqualityComparer<ResolvedImport>
600 public static ResolvedImportComparer Instance = new ResolvedImportComparer ();
602 public bool Equals (ResolvedImport x, ResolvedImport y)
604 return x.ImportedProject.FullPath.Equals (y.ImportedProject.FullPath);
606 public int GetHashCode (ResolvedImport obj)
608 return obj.ImportedProject.FullPath.GetHashCode ();
612 public IList<ResolvedImport> Imports {
613 get { return raw_imports.Distinct (ResolvedImportComparer.Instance).ToList (); }
616 public IList<ResolvedImport> ImportsIncludingDuplicates {
617 get { return raw_imports; }
620 public bool IsBuildEnabled {
621 get { return ProjectCollection.IsBuildEnabled; }
625 public bool IsDirty {
626 get { return is_dirty; }
629 public IDictionary<string, ProjectItemDefinition> ItemDefinitions {
630 get { return item_definitions; }
633 [MonoTODO ("should be different from AllEvaluatedItems")]
634 public ICollection<ProjectItem> Items {
635 get { return AllEvaluatedItems; }
638 public ICollection<ProjectItem> ItemsIgnoringCondition {
639 get { return raw_items; }
642 public ICollection<string> ItemTypes {
643 get { return new CollectionFromEnumerable<string> (raw_items.Select (i => i.ItemType).Distinct ()); }
646 [MonoTODO ("should be different from AllEvaluatedProperties")]
647 public ICollection<ProjectProperty> Properties {
648 get { return AllEvaluatedProperties; }
651 public bool SkipEvaluation { get; set; }
658 IDictionary<string, ProjectTargetInstance> Targets {
659 get { return targets; }
662 // These are required for reserved property, represents dynamically changing property values.
663 // This should resolve to either the project file path or that of the imported file.
664 internal string GetEvaluationTimeThisFileDirectory ()
666 var file = GetEvaluationTimeThisFile ();
667 var dir = Path.IsPathRooted (file) ? Path.GetDirectoryName (file) : Directory.GetCurrentDirectory ();
668 return dir + Path.DirectorySeparatorChar;
671 internal string GetEvaluationTimeThisFile ()
673 return ProjectCollection.OngoingImports.Count > 0 ? ProjectCollection.OngoingImports.Peek () : FullPath ?? string.Empty;
676 internal string GetFullPath (string pathRelativeToProject)
678 if (Path.IsPathRooted (pathRelativeToProject))
679 return pathRelativeToProject;
680 return Path.GetFullPath (Path.Combine (DirectoryPath, pathRelativeToProject));