mcs/class/Microsoft.Build/Microsoft.Build.Evaluation/Project.cs

   1 //
   2 // Project.cs
   3 //
   4 // Author:
   5 //   Leszek Ciesielski (skolima@gmail.com)
   6 //   Rolf Bjarne Kvinge (rolf@xamarin.com)
   7 //   Atsushi Enomoto (atsushi@xamarin.com)
   8 //
   9 // (C) 2011 Leszek Ciesielski
  10 // Copyright (C) 2011,2013 Xamarin Inc. (http://www.xamarin.com)
  11 //
  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:
  19 //
  20 // The above copyright notice and this permission notice shall be
  21 // included in all copies or substantial portions of the Software.
  22 //
  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.
  30 //
  31
  32 using System;
  33 using System.Collections.Generic;
  34 using System.Diagnostics;
  35 using System.IO;
  36 using System.Linq;
  37 using System.Text;
  38 using System.Xml;
  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.Internal.Expressions;
  45 using Microsoft.Build.Logging;
  46 using System.Collections;
  47
  48 // Basically there are two semantic Project object models and their relationship is not obvious
  49 // (apart from Microsoft.Build.Construction.ProjectRootElement which is a "construction rule").
  50 //
  51 // Microsoft.Build.Evaluation.Project holds some "editable" project model, and it supports
  52 // detailed loader API (such as Items and AllEvaluatedItems).
  53 // ProjectPoperty holds UnevaluatedValue and gives EvaluatedValue too.
  54 //
  55 // Microsoft.Build.Execution.ProjectInstance holds "snapshot" of a project, and it lacks
  56 // detailed loader API. It does not give us Unevaluated property value.
  57 // On the other hand, it supports Targets object model. What Microsoft.Build.Evaluation.Project
  58 // offers there is actually a list of Microsoft.Build.Execution.ProjectInstance objects.
  59 // It should be also noted that only ProjectInstance has Evaluate() method (Project doesn't).
  60 //
  61 // And both API holds different set of descendant types for each and cannot really share the
  62 // loader code. That is lame.
  63 //
  64 // So, can either of them be used to construct the other model? Both API models share the same
  65 // "governor", which is Microsoft.Build.Evaluation.ProjectCollection/ Project is added to
  66 // its LoadedProjects list, while ProjectInstance isn't. Project cannot be loaded to load
  67 // a ProjectInstance, at least within the same ProjectCollection.
  68 //
  69 // On the other hand, can ProjectInstance be used to load a Project? Maybe. Since Project and
  70 // its descendants need Microsoft.Build.Construction.ProjectElement family as its API model
  71 // is part of the public API. Then I still have to understand how those AllEvaluatedItems/
  72 // AllEvaluatedProperties members make sense. EvaluationCounter is another propery in question.
  73
  74 namespace Microsoft.Build.Evaluation
  75 {
  76         [DebuggerDisplay ("{FullPath} EffectiveToolsVersion={ToolsVersion} #GlobalProperties="
  77         + "{data.globalProperties.Count} #Properties={data.Properties.Count} #ItemTypes="
  78         + "{data.ItemTypes.Count} #ItemDefinitions={data.ItemDefinitions.Count} #Items="
  79         + "{data.Items.Count} #Targets={data.Targets.Count}")]
  80         public class Project
  81         {
  82                 public Project (XmlReader xml)
  83                         : this (ProjectRootElement.Create (xml))
  84                 {
  85                 }
  86
  87                 public Project (XmlReader xml, IDictionary<string, string> globalProperties,
  88                                               string toolsVersion)
  89                         : this (ProjectRootElement.Create (xml), globalProperties, toolsVersion)
  90                 {
  91                 }
  92
  93                 public Project (XmlReader xml, IDictionary<string, string> globalProperties,
  94                                               string toolsVersion, ProjectCollection projectCollection)
  95                         : this (ProjectRootElement.Create (xml), globalProperties, toolsVersion, projectCollection)
  96                 {
  97                 }
  98
  99                 public Project (XmlReader xml, IDictionary<string, string> globalProperties,
 100                                               string toolsVersion, ProjectCollection projectCollection,
 101                                               ProjectLoadSettings loadSettings)
 102                         : this (ProjectRootElement.Create (xml), globalProperties, toolsVersion, projectCollection, loadSettings)
 103                 {
 104                 }
 105
 106                 public Project (ProjectRootElement xml) : this (xml, null, null)
 107                 {
 108                 }
 109
 110                 public Project (ProjectRootElement xml, IDictionary<string, string> globalProperties,
 111                                               string toolsVersion)
 112                         : this (xml, globalProperties, toolsVersion, ProjectCollection.GlobalProjectCollection)
 113                 {
 114                 }
 115
 116                 public Project (ProjectRootElement xml, IDictionary<string, string> globalProperties,
 117                                               string toolsVersion, ProjectCollection projectCollection)
 118                         : this (xml, globalProperties, toolsVersion, projectCollection, ProjectLoadSettings.Default)
 119                 {
 120                 }
 121
 122                 public Project (ProjectRootElement xml, IDictionary<string, string> globalProperties,
 123                                               string toolsVersion, ProjectCollection projectCollection,
 124                                               ProjectLoadSettings loadSettings)
 125                 {
 126                         if (projectCollection == null)
 127                                 throw new ArgumentNullException ("projectCollection");
 128                         this.Xml = xml;
 129                         this.GlobalProperties = globalProperties ?? new Dictionary<string, string> ();
 130                         this.ToolsVersion = toolsVersion;
 131                         this.ProjectCollection = projectCollection;
 132                         this.load_settings = loadSettings;
 133
 134                         Initialize ();
 135                 }
 136
 137                 public Project (string projectFile)
 138                         : this (projectFile, null, null)
 139                 {
 140                 }
 141
 142                 public Project (string projectFile, IDictionary<string, string> globalProperties,
 143                                 string toolsVersion)
 144                 : this (projectFile, globalProperties, toolsVersion, ProjectCollection.GlobalProjectCollection, ProjectLoadSettings.Default)
 145                 {
 146                 }
 147
 148                 public Project (string projectFile, IDictionary<string, string> globalProperties,
 149                                 string toolsVersion, ProjectCollection projectCollection)
 150                 : this (projectFile, globalProperties, toolsVersion, projectCollection, ProjectLoadSettings.Default)
 151                 {
 152                 }
 153
 154                 public Project (string projectFile, IDictionary<string, string> globalProperties,
 155                                 string toolsVersion, ProjectCollection projectCollection,
 156                                 ProjectLoadSettings loadSettings)
 157                         : this (ProjectRootElement.Create (projectFile), globalProperties, toolsVersion, projectCollection, loadSettings)
 158                 {
 159                 }
 160
 161                 ProjectLoadSettings load_settings;
 162
 163                 public IDictionary<string, string> GlobalProperties { get; private set; }
 164
 165                 public ProjectCollection ProjectCollection { get; private set; }
 166
 167                 public string ToolsVersion { get; private set; }
 168
 169                 public ProjectRootElement Xml { get; private set; }
 170
 171                 string dir_path;
 172                 Dictionary<string, ProjectItemDefinition> item_definitions;
 173                 List<ResolvedImport> raw_imports;
 174                 List<ProjectItem> raw_items;
 175                 List<ProjectItem> all_evaluated_items;
 176                 List<ProjectProperty> properties;
 177                 Dictionary<string, ProjectTargetInstance> targets;
 178
 179                 void Initialize ()
 180                 {
 181                         dir_path = Directory.GetCurrentDirectory ();
 182                         raw_imports = new List<ResolvedImport> ();
 183                         item_definitions = new Dictionary<string, ProjectItemDefinition> ();
 184                         targets = new Dictionary<string, ProjectTargetInstance> ();
 185                         raw_items = new List<ProjectItem> ();
 186
 187                         properties = new List<ProjectProperty> ();
 188
 189                         foreach (DictionaryEntry p in Environment.GetEnvironmentVariables ())
 190                                 // FIXME: this is kind of workaround for unavoidable issue that PLATFORM=* is actually given
 191                                 // on some platforms and that prevents setting default "PLATFORM=AnyCPU" property.
 192                                 if (!string.Equals ("PLATFORM", (string) p.Key, StringComparison.OrdinalIgnoreCase))
 193                                         this.properties.Add (new EnvironmentProjectProperty (this, (string)p.Key, (string)p.Value));
 194                         foreach (var p in GlobalProperties)
 195                                 this.properties.Add (new GlobalProjectProperty (this, p.Key, p.Value));
 196                         var tools = ProjectCollection.GetToolset (this.ToolsVersion) ?? ProjectCollection.GetToolset (this.ProjectCollection.DefaultToolsVersion);
 197                         foreach (var p in ProjectCollection.GetReservedProperties (tools, this))
 198                                 this.properties.Add (p);
 199                         foreach (var p in ProjectCollection.GetWellKnownProperties (this))
 200                                 this.properties.Add (p);
 201
 202                         ProcessXml ();
 203
 204                         ProjectCollection.AddProject (this);
 205                 }
 206
 207                 void ProcessXml ()
 208                 {
 209                         // this needs to be initialized here (regardless of that items won't be evaluated at property evaluation;
 210                         // Conditions could incorrectly reference items and lack of this list causes NRE.
 211                         all_evaluated_items = new List<ProjectItem> ();
 212
 213                         // property evaluation happens couple of times.
 214                         // At first step, all non-imported properties are evaluated TOO, WHILE those properties are being evaluated.
 215                         // This means, Include and IncludeGroup elements with Condition attribute MAY contain references to
 216                         // properties and they will be expanded.
 217                         var elements = EvaluatePropertiesAndImportsAndChooses (Xml.Children).ToArray (); // ToArray(): to not lazily evaluate elements.
 218
 219                         // next, evaluate items
 220                         EvaluateItems (elements);
 221
 222                         // finally, evaluate targets and tasks
 223                         EvaluateTargets (elements);
 224                 }
 225
 226                 IEnumerable<ProjectElement> EvaluatePropertiesAndImportsAndChooses (IEnumerable<ProjectElement> elements)
 227                 {
 228                         // First step: evaluate Properties
 229                         foreach (var child in elements) {
 230                                 yield return child;
 231                                 var pge = child as ProjectPropertyGroupElement;
 232                                 if (pge != null && Evaluate (pge.Condition))
 233                                         foreach (var p in pge.Properties)
 234                                                 // do not allow overwriting reserved or well-known properties by user
 235                                                 if (!this.properties.Any (_ => (_.IsReservedProperty || _.IsWellKnownProperty) && _.Name.Equals (p.Name, StringComparison.InvariantCultureIgnoreCase)))
 236                                                         if (Evaluate (p.Condition))
 237                                                                 this.properties.Add (new XmlProjectProperty (this, p, PropertyType.Normal, ProjectCollection.OngoingImports.Any ()));
 238
 239                                 var ige = child as ProjectImportGroupElement;
 240                                 if (ige != null && Evaluate (ige.Condition)) {
 241                                         foreach (var incc in ige.Imports) {
 242                                                 if (Evaluate (incc.Condition))
 243                                                         foreach (var e in Import (incc))
 244                                                                 yield return e;
 245                                         }
 246                                 }
 247                                 var inc = child as ProjectImportElement;
 248                                 if (inc != null && Evaluate (inc.Condition))
 249                                         foreach (var e in Import (inc))
 250                                                 yield return e;
 251                                 var choose = child as ProjectChooseElement;
 252                                 if (choose != null && Evaluate (choose.Condition)) {
 253                                         bool done = false;
 254                                         foreach (ProjectWhenElement when in choose.WhenElements)
 255                                                 if (Evaluate (when.Condition)) {
 256                                                         foreach (var e in EvaluatePropertiesAndImportsAndChooses (when.Children))
 257                                                                 yield return e;
 258                                                         done = true;
 259                                                         break;
 260                                                 }
 261                                         if (!done && choose.OtherwiseElement != null)
 262                                                 foreach (var e in EvaluatePropertiesAndImportsAndChooses (choose.OtherwiseElement.Children))
 263                                                         yield return e;
 264                                 }
 265                         }
 266                 }
 267
 268                 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)
 269                 {
 270                         return ProjectCollection.GetAllItems<T> (ExpandString, include, exclude, creator, taskItemCreator, DirectoryPath, assignRecurse,
 271                                 t => all_evaluated_items.Any (i => i.EvaluatedInclude == t.ItemSpec && itemTypeCheck (i.ItemType)));
 272                 }
 273
 274                 void EvaluateItems (IEnumerable<ProjectElement> elements)
 275                 {
 276                         foreach (var child in elements) {
 277                                 var ige = child as ProjectItemGroupElement;
 278                                 if (ige != null) {
 279                                         foreach (var p in ige.Items) {
 280                                                 if (!Evaluate (ige.Condition) || !Evaluate (p.Condition))
 281                                                         continue;
 282                                                 Func<string,ProjectItem> creator = s => new ProjectItem (this, p, s);
 283                                                 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)) {
 284                                                         raw_items.Add (item);
 285                                                         all_evaluated_items.Add (item);
 286                                                 }
 287                                         }
 288                                 }
 289                                 var def = child as ProjectItemDefinitionGroupElement;
 290                                 if (def != null) {
 291                                         foreach (var p in def.ItemDefinitions) {
 292                                                 if (Evaluate (p.Condition)) {
 293                                                         ProjectItemDefinition existing;
 294                                                         if (!item_definitions.TryGetValue (p.ItemType, out existing))
 295                                                                 item_definitions.Add (p.ItemType, (existing = new ProjectItemDefinition (this, p.ItemType)));
 296                                                         existing.AddItems (p);
 297                                                 }
 298                                         }
 299                                 }
 300                         }
 301                         all_evaluated_items.Sort ((p1, p2) => string.Compare (p1.ItemType, p2.ItemType, StringComparison.OrdinalIgnoreCase));
 302                 }
 303
 304                 void EvaluateTargets (IEnumerable<ProjectElement> elements)
 305                 {
 306                         foreach (var child in elements) {
 307                                 var te = child as ProjectTargetElement;
 308                                 if (te != null)
 309                                         // It overwrites same name target.
 310                                         this.targets [te.Name] = new ProjectTargetInstance (te);
 311                         }
 312                 }
 313
 314                 IEnumerable<ProjectElement> Import (ProjectImportElement import)
 315                 {
 316                         string dir = ProjectCollection.GetEvaluationTimeThisFileDirectory (() => FullPath);
 317                         // FIXME: use appropriate logger (but cannot be instantiated here...?)
 318                         string path = ProjectCollection.FindFileInSeveralExtensionsPath (ref extensions_path_override, ExpandString, import.Project, TextWriter.Null.WriteLine);
 319                         path = Path.IsPathRooted (path) ? path : dir != null ? Path.Combine (dir, path) : Path.GetFullPath (path);
 320                         if (ProjectCollection.OngoingImports.Contains (path)) {
 321                                 switch (load_settings) {
 322                                 case ProjectLoadSettings.RejectCircularImports:
 323                                         throw new InvalidProjectFileException (import.Location, null, string.Format ("Circular imports was detected: {0} (resolved as \"{1}\") is already on \"importing\" stack", import.Project, path));
 324                                 }
 325                                 return new ProjectElement [0]; // do not import circular references
 326                         }
 327                         ProjectCollection.OngoingImports.Push (path);
 328                         try {
 329                                 using (var reader = XmlReader.Create (path)) {
 330                                         var root = ProjectRootElement.Create (reader, ProjectCollection);
 331                                         raw_imports.Add (new ResolvedImport (import, root, true));
 332                                         return this.EvaluatePropertiesAndImportsAndChooses (root.Children).ToArray ();
 333                                 }
 334                         } finally {
 335                                 ProjectCollection.OngoingImports.Pop ();
 336                         }
 337                 }
 338
 339                 public ICollection<ProjectItem> GetItemsIgnoringCondition (string itemType)
 340                 {
 341                         return new CollectionFromEnumerable<ProjectItem> (raw_items.Where (p => p.ItemType.Equals (itemType, StringComparison.OrdinalIgnoreCase)));
 342                 }
 343
 344                 public void RemoveItems (IEnumerable<ProjectItem> items)
 345                 {
 346                         var removal = new List<ProjectItem> (items);
 347                         foreach (var item in removal) {
 348                                 var parent = item.Xml.Parent;
 349                                 parent.RemoveChild (item.Xml);
 350                                 if (parent.Count == 0)
 351                                         parent.Parent.RemoveChild (parent);
 352                         }
 353                 }
 354
 355                 static readonly Dictionary<string, string> empty_metadata = new Dictionary<string, string> ();
 356
 357                 public IList<ProjectItem> AddItem (string itemType, string unevaluatedInclude)
 358                 {
 359                         return AddItem (itemType, unevaluatedInclude, empty_metadata);
 360                 }
 361
 362                 public IList<ProjectItem> AddItem (string itemType, string unevaluatedInclude,
 363                                 IEnumerable<KeyValuePair<string, string>> metadata)
 364                 {
 365                         // FIXME: needs several check that AddItemFast() does not process (see MSDN for details).
 366
 367                         return AddItemFast (itemType, unevaluatedInclude, metadata);
 368                 }
 369
 370                 public IList<ProjectItem> AddItemFast (string itemType, string unevaluatedInclude)
 371                 {
 372                         return AddItemFast (itemType, unevaluatedInclude, empty_metadata);
 373                 }
 374
 375                 public IList<ProjectItem> AddItemFast (string itemType, string unevaluatedInclude,
 376                                                                      IEnumerable<KeyValuePair<string, string>> metadata)
 377                 {
 378                         throw new NotImplementedException ();
 379                 }
 380
 381                 static readonly char [] target_sep = new char[] {';'};
 382
 383                 public bool Build ()
 384                 {
 385                         return Build (GetDefaultTargets (Xml));
 386                 }
 387
 388                 public bool Build (IEnumerable<ILogger> loggers)
 389                 {
 390                         return Build (GetDefaultTargets (Xml), loggers);
 391                 }
 392
 393                 public bool Build (string target)
 394                 {
 395                         return string.IsNullOrWhiteSpace (target) ? Build () : Build (new string [] {target});
 396                 }
 397
 398                 public bool Build (string[] targets)
 399                 {
 400                         return Build (targets, new ILogger [0]);
 401                 }
 402
 403                 public bool Build (ILogger logger)
 404                 {
 405                         return Build (GetDefaultTargets (Xml), new ILogger [] {logger});
 406                 }
 407
 408                 public bool Build (string[] targets, IEnumerable<ILogger> loggers)
 409                 {
 410                         return Build (targets, loggers, new ForwardingLoggerRecord [0]);
 411                 }
 412
 413                 public bool Build (IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
 414                 {
 415                         return Build (GetDefaultTargets (Xml), loggers, remoteLoggers);
 416                 }
 417
 418                 public bool Build (string target, IEnumerable<ILogger> loggers)
 419                 {
 420                         return Build (new string [] { target }, loggers);
 421                 }
 422
 423                 public bool Build (string[] targets, IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
 424                 {
 425                         // Unlike ProjectInstance.Build(), there is no place to fill outputs by targets, so ignore them
 426                         // (i.e. we don't use the overload with output).
 427                         //
 428                         // This does not check FullPath, so don't call GetProjectInstanceForBuild() directly.
 429                         return new BuildManager ().GetProjectInstanceForBuildInternal (this).Build (targets, loggers, remoteLoggers);
 430                 }
 431
 432                 public bool Build (string target, IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers)
 433                 {
 434                         return Build (new string [] { target }, loggers, remoteLoggers);
 435                 }
 436
 437                 // FIXME: this is a duplicate code between Project and ProjectInstance
 438                 static readonly char [] item_target_sep = {';'};
 439
 440                 string [] GetDefaultTargets (ProjectRootElement xml)
 441                 {
 442                         var ret = GetDefaultTargets (xml, true, true);
 443                         return ret.Any () ? ret : GetDefaultTargets (xml, false, true);
 444                 }
 445
 446                 string [] GetDefaultTargets (ProjectRootElement xml, bool fromAttribute, bool checkImports)
 447                 {
 448                         if (fromAttribute) {
 449                                 var ret = xml.DefaultTargets.Split (item_target_sep, StringSplitOptions.RemoveEmptyEntries).Select (s => s.Trim ()).ToArray ();
 450                                 if (checkImports && ret.Length == 0) {
 451                                         foreach (var imp in this.raw_imports) {
 452                                                 ret = GetDefaultTargets (imp.ImportedProject, true, false);
 453                                                 if (ret.Any ())
 454                                                         break;
 455                                         }
 456                                 }
 457                                 return ret;
 458                         } else {
 459                                 if (xml.Targets.Any ())
 460                                         return new String [] { xml.Targets.First ().Name };
 461                                 if (checkImports) {
 462                                         foreach (var imp in this.raw_imports) {
 463                                                 var ret = GetDefaultTargets (imp.ImportedProject, false, false);
 464                                                 if (ret.Any ())
 465                                                         return ret;
 466                                         }
 467                                 }
 468                                 return new string [0];
 469                         }
 470                 }
 471
 472                 public ProjectInstance CreateProjectInstance ()
 473                 {
 474                         var ret = new ProjectInstance (Xml, GlobalProperties, ToolsVersion, ProjectCollection);
 475                         // FIXME: maybe fill other properties to the result.
 476                         return ret;
 477                 }
 478
 479                 bool Evaluate (string unexpandedValue)
 480                 {
 481                         return string.IsNullOrWhiteSpace (unexpandedValue) || new ExpressionEvaluator (this).EvaluateAsBoolean (unexpandedValue);
 482                 }
 483
 484                 public string ExpandString (string unexpandedValue)
 485                 {
 486                         return WindowsCompatibilityExtensions.NormalizeFilePath (new ExpressionEvaluator (this).Evaluate (unexpandedValue));
 487                 }
 488
 489                 public static string GetEvaluatedItemIncludeEscaped (ProjectItem item)
 490                 {
 491                         return ProjectCollection.Escape (item.EvaluatedInclude);
 492                 }
 493
 494                 public static string GetEvaluatedItemIncludeEscaped (ProjectItemDefinition item)
 495                 {
 496                         // ?? ItemDefinition does not have Include attribute. What's the point here?
 497                         throw new NotImplementedException ();
 498                 }
 499
 500                 public ICollection<ProjectItem> GetItems (string itemType)
 501                 {
 502                         return new CollectionFromEnumerable<ProjectItem> (Items.Where (p => p.ItemType.Equals (itemType, StringComparison.OrdinalIgnoreCase)));
 503                 }
 504
 505                 public ICollection<ProjectItem> GetItemsByEvaluatedInclude (string evaluatedInclude)
 506                 {
 507                         return new CollectionFromEnumerable<ProjectItem> (Items.Where (p => p.EvaluatedInclude.Equals (evaluatedInclude, StringComparison.OrdinalIgnoreCase)));
 508                 }
 509
 510                 public IEnumerable<ProjectElement> GetLogicalProject ()
 511                 {
 512                         throw new NotImplementedException ();
 513                 }
 514
 515                 public static string GetMetadataValueEscaped (ProjectMetadata metadatum)
 516                 {
 517                         return ProjectCollection.Escape (metadatum.EvaluatedValue);
 518                 }
 519
 520                 public static string GetMetadataValueEscaped (ProjectItem item, string name)
 521                 {
 522                         var md = item.Metadata.FirstOrDefault (m => m.Name.Equals (name, StringComparison.OrdinalIgnoreCase));
 523                         return md != null ? ProjectCollection.Escape (md.EvaluatedValue) : null;
 524                 }
 525
 526                 public static string GetMetadataValueEscaped (ProjectItemDefinition item, string name)
 527                 {
 528                         var md = item.Metadata.FirstOrDefault (m => m.Name.Equals (name, StringComparison.OrdinalIgnoreCase));
 529                         return md != null ? ProjectCollection.Escape (md.EvaluatedValue) : null;
 530                 }
 531
 532                 public string GetPropertyValue (string name)
 533                 {
 534                         var prop = GetProperty (name);
 535                         return prop != null ? prop.EvaluatedValue : string.Empty;
 536                 }
 537
 538                 public static string GetPropertyValueEscaped (ProjectProperty property)
 539                 {
 540                         // WTF happens here.
 541                         //return ProjectCollection.Escape (property.EvaluatedValue);
 542                         return property.EvaluatedValue;
 543                 }
 544
 545                 string extensions_path_override;
 546
 547                 public ProjectProperty GetProperty (string name)
 548                 {
 549                         if (extensions_path_override != null && (name.Equals ("MSBuildExtensionsPath") || name.Equals ("MSBuildExtensionsPath32") || name.Equals ("MSBuildExtensionsPath64")))
 550                                 return new ReservedProjectProperty (this, name, () => extensions_path_override);
 551                         return properties.FirstOrDefault (p => p.Name.Equals (name, StringComparison.OrdinalIgnoreCase));
 552                 }
 553
 554                 public void MarkDirty ()
 555                 {
 556                         if (!DisableMarkDirty)
 557                                 is_dirty = true;
 558                 }
 559
 560                 public void ReevaluateIfNecessary ()
 561                 {
 562                         throw new NotImplementedException ();
 563                 }
 564
 565                 public bool RemoveGlobalProperty (string name)
 566                 {
 567                         throw new NotImplementedException ();
 568                 }
 569
 570                 public bool RemoveItem (ProjectItem item)
 571                 {
 572                         throw new NotImplementedException ();
 573                 }
 574
 575                 public bool RemoveProperty (ProjectProperty property)
 576                 {
 577                         var removed = properties.FirstOrDefault (p => p.Name.Equals (property.Name, StringComparison.OrdinalIgnoreCase));
 578                         if (removed == null)
 579                                 return false;
 580                         properties.Remove (removed);
 581                         return true;
 582                 }
 583
 584                 public void Save ()
 585                 {
 586                         Xml.Save ();
 587                 }
 588
 589                 public void Save (TextWriter writer)
 590                 {
 591                         Xml.Save (writer);
 592                 }
 593
 594                 public void Save (string path)
 595                 {
 596                         Save (path, Encoding.Default);
 597                 }
 598
 599                 public void Save (Encoding encoding)
 600                 {
 601                         Save (FullPath, encoding);
 602                 }
 603
 604                 public void Save (string path, Encoding encoding)
 605                 {
 606                         using (var writer = new StreamWriter (path, false, encoding))
 607                                 Save (writer);
 608                 }
 609
 610                 public void SaveLogicalProject (TextWriter writer)
 611                 {
 612                         throw new NotImplementedException ();
 613                 }
 614
 615                 public bool SetGlobalProperty (string name, string escapedValue)
 616                 {
 617                         throw new NotImplementedException ();
 618                 }
 619
 620                 public ProjectProperty SetProperty (string name, string unevaluatedValue)
 621                 {
 622                         var p = new ManuallyAddedProjectProperty (this, name, unevaluatedValue);
 623                         properties.Add (p);
 624                         return p;
 625                 }
 626
 627                 public ICollection<ProjectMetadata> AllEvaluatedItemDefinitionMetadata {
 628                         get { throw new NotImplementedException (); }
 629                 }
 630
 631                 public ICollection<ProjectItem> AllEvaluatedItems {
 632                         get { return all_evaluated_items; }
 633                 }
 634
 635                 public ICollection<ProjectProperty> AllEvaluatedProperties {
 636                         get { return properties; }
 637                 }
 638
 639                 public IDictionary<string, List<string>> ConditionedProperties {
 640                         get {
 641                                 // this property returns different instances every time.
 642                                 var dic = new Dictionary<string, List<string>> ();
 643
 644                                 // but I dunno HOW this evaluates
 645
 646                                 throw new NotImplementedException ();
 647                         }
 648                 }
 649
 650                 public string DirectoryPath {
 651                         get { return dir_path; }
 652                 }
 653
 654                 public bool DisableMarkDirty { get; set; }
 655
 656                 public int EvaluationCounter {
 657                         get { throw new NotImplementedException (); }
 658                 }
 659
 660                 public string FullPath {
 661                         get { return Xml.FullPath; }
 662                         set { Xml.FullPath = value; }
 663                 }
 664
 665                 class ResolvedImportComparer : IEqualityComparer<ResolvedImport>
 666                 {
 667                         public static ResolvedImportComparer Instance = new ResolvedImportComparer ();
 668
 669                         public bool Equals (ResolvedImport x, ResolvedImport y)
 670                         {
 671                                 return x.ImportedProject.FullPath.Equals (y.ImportedProject.FullPath);
 672                         }
 673                         public int GetHashCode (ResolvedImport obj)
 674                         {
 675                                 return obj.ImportedProject.FullPath.GetHashCode ();
 676                         }
 677                 }
 678
 679                 public IList<ResolvedImport> Imports {
 680                         get { return raw_imports.Distinct (ResolvedImportComparer.Instance).ToList (); }
 681                 }
 682
 683                 public IList<ResolvedImport> ImportsIncludingDuplicates {
 684                         get { return raw_imports; }
 685                 }
 686
 687                 public bool IsBuildEnabled {
 688                         get { return ProjectCollection.IsBuildEnabled; }
 689                 }
 690
 691                 bool is_dirty;
 692                 public bool IsDirty {
 693                         get { return is_dirty; }
 694                 }
 695
 696                 public IDictionary<string, ProjectItemDefinition> ItemDefinitions {
 697                         get { return item_definitions; }
 698                 }
 699
 700                 [MonoTODO ("should be different from AllEvaluatedItems")]
 701                 public ICollection<ProjectItem> Items {
 702                         get { return AllEvaluatedItems; }
 703                 }
 704
 705                 public ICollection<ProjectItem> ItemsIgnoringCondition {
 706                         get { return raw_items; }
 707                 }
 708
 709                 public ICollection<string> ItemTypes {
 710                         get { return new CollectionFromEnumerable<string> (raw_items.Select (i => i.ItemType).Distinct ()); }
 711                 }
 712
 713                 [MonoTODO ("should be different from AllEvaluatedProperties")]
 714                 public ICollection<ProjectProperty> Properties {
 715                         get { return AllEvaluatedProperties; }
 716                 }
 717
 718                 public bool SkipEvaluation { get; set; }
 719
 720                 public
 721                 IDictionary<string, ProjectTargetInstance> Targets {
 722                         get { return targets; }
 723                 }
 724
 725                 // These are required for reserved property, represents dynamically changing property values.
 726                 // This should resolve to either the project file path or that of the imported file.
 727                 internal string GetEvaluationTimeThisFileDirectory ()
 728                 {
 729                         var file = GetEvaluationTimeThisFile ();
 730                         var dir = Path.IsPathRooted (file) ? Path.GetDirectoryName (file) : Directory.GetCurrentDirectory ();
 731                         return dir + Path.DirectorySeparatorChar;
 732                 }
 733
 734                 internal string GetEvaluationTimeThisFile ()
 735                 {
 736                         return ProjectCollection.OngoingImports.Count > 0 ? ProjectCollection.OngoingImports.Peek () : FullPath ?? string.Empty;
 737                 }
 738
 739                 internal string GetFullPath (string pathRelativeToProject)
 740                 {
 741                         if (Path.IsPathRooted (pathRelativeToProject))
 742                                 return pathRelativeToProject;
 743                         return Path.GetFullPath (Path.Combine (DirectoryPath, pathRelativeToProject));
 744                 }
 745         }
 746 }