2 // ProjectCollection.cs
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.
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.
32 using Microsoft.Build.Construction;
33 using Microsoft.Build.Execution;
34 using Microsoft.Build.Framework;
35 using Microsoft.Build.Logging;
36 using Microsoft.Build.Utilities;
38 using System.Collections.Generic;
39 using System.Collections.ObjectModel;
43 using System.Reflection;
44 using System.Globalization;
45 using Mono.XBuild.Utilities;
46 using Microsoft.Build.Internal;
48 namespace Microsoft.Build.Evaluation
50 public class ProjectCollection : IDisposable
52 public delegate void ProjectAddedEventHandler (object sender, ProjectAddedToProjectCollectionEventArgs e);
54 public class ProjectAddedToProjectCollectionEventArgs : EventArgs
56 public ProjectAddedToProjectCollectionEventArgs (ProjectRootElement element)
59 throw new ArgumentNullException ("project");
60 ProjectRootElement = element;
63 public ProjectRootElement ProjectRootElement { get; private set; }
68 static readonly ProjectCollection global_project_collection;
70 static ProjectCollection ()
72 global_project_collection = new ProjectCollection (new ReadOnlyDictionary<string, string> (new Dictionary<string, string> ()));
75 public static string Escape (string unescapedString)
77 return Mono.XBuild.Utilities.MSBuildUtils.Escape (unescapedString);
80 public static string Unescape (string escapedString)
82 return Mono.XBuild.Utilities.MSBuildUtils.Unescape (escapedString);
85 public static ProjectCollection GlobalProjectCollection {
86 get { return global_project_collection; }
89 // semantic model part
91 public ProjectCollection ()
96 public ProjectCollection (IDictionary<string, string> globalProperties)
97 : this (globalProperties, null, ToolsetDefinitionLocations.Registry | ToolsetDefinitionLocations.ConfigurationFile)
101 public ProjectCollection (ToolsetDefinitionLocations toolsetLocations)
102 : this (null, null, toolsetLocations)
106 public ProjectCollection (IDictionary<string, string> globalProperties, IEnumerable<ILogger> loggers,
107 ToolsetDefinitionLocations toolsetDefinitionLocations)
108 : this (globalProperties, loggers, null, toolsetDefinitionLocations, 1, false)
112 public ProjectCollection (IDictionary<string, string> globalProperties,
113 IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers,
114 ToolsetDefinitionLocations toolsetDefinitionLocations,
115 int maxNodeCount, bool onlyLogCriticalEvents)
117 global_properties = globalProperties ?? new Dictionary<string, string> ();
118 this.loggers = loggers != null ? loggers.ToList () : new List<ILogger> ();
119 toolset_locations = toolsetDefinitionLocations;
120 MaxNodeCount = maxNodeCount;
121 OnlyLogCriticalEvents = onlyLogCriticalEvents;
123 LoadDefaultToolsets ();
126 [MonoTODO ("not fired yet")]
127 public event ProjectAddedEventHandler ProjectAdded;
128 [MonoTODO ("not fired yet")]
129 public event EventHandler<ProjectChangedEventArgs> ProjectChanged;
130 [MonoTODO ("not fired yet")]
131 public event EventHandler<ProjectCollectionChangedEventArgs> ProjectCollectionChanged;
132 [MonoTODO ("not fired yet")]
133 public event EventHandler<ProjectXmlChangedEventArgs> ProjectXmlChanged;
135 public void AddProject (Project project)
137 this.loaded_projects.Add (project);
138 if (ProjectAdded != null)
139 ProjectAdded (this, new ProjectAddedToProjectCollectionEventArgs (project.Xml));
143 get { return loaded_projects.Count; }
146 string default_tools_version;
147 public string DefaultToolsVersion {
148 get { return default_tools_version; }
150 if (GetToolset (value) == null)
151 throw new InvalidOperationException (string.Format ("Toolset '{0}' does not exist", value));
152 default_tools_version = value;
156 public void Dispose ()
159 GC.SuppressFinalize (this);
162 protected virtual void Dispose (bool disposing)
168 public ICollection<Project> GetLoadedProjects (string fullPath)
170 return LoadedProjects.Where (p => p.FullPath != null && Path.GetFullPath (p.FullPath) == Path.GetFullPath (fullPath)).ToList ();
173 readonly IDictionary<string, string> global_properties;
175 public IDictionary<string, string> GlobalProperties {
176 get { return global_properties; }
179 readonly List<Project> loaded_projects = new List<Project> ();
181 public Project LoadProject (string fileName)
183 return LoadProject (fileName, DefaultToolsVersion);
186 public Project LoadProject (string fileName, string toolsVersion)
188 return LoadProject (fileName, null, toolsVersion);
191 public Project LoadProject (string fileName, IDictionary<string,string> globalProperties, string toolsVersion)
193 var ret = new Project (fileName, globalProperties, toolsVersion);
194 loaded_projects.Add (ret);
198 // These methods somehow don't add the project to ProjectCollection...
199 public Project LoadProject (XmlReader xmlReader)
201 return LoadProject (xmlReader, DefaultToolsVersion);
204 public Project LoadProject (XmlReader xmlReader, string toolsVersion)
206 return LoadProject (xmlReader, null, toolsVersion);
209 public Project LoadProject (XmlReader xmlReader, IDictionary<string,string> globalProperties, string toolsVersion)
211 return new Project (xmlReader, globalProperties, toolsVersion);
214 public ICollection<Project> LoadedProjects {
215 get { return loaded_projects; }
218 readonly List<ILogger> loggers = new List<ILogger> ();
220 public ICollection<ILogger> Loggers {
221 get { return loggers; }
225 public bool OnlyLogCriticalEvents { get; set; }
228 public bool SkipEvaluation { get; set; }
230 readonly ToolsetDefinitionLocations toolset_locations;
231 public ToolsetDefinitionLocations ToolsetLocations {
232 get { return toolset_locations; }
235 readonly List<Toolset> toolsets = new List<Toolset> ();
236 // so what should we do without ToolLocationHelper in Microsoft.Build.Utilities.dll? There is no reference to it in this dll.
237 public ICollection<Toolset> Toolsets {
238 // For ConfigurationFile and None, they cannot be added externally.
239 get { return (ToolsetLocations & ToolsetDefinitionLocations.Registry) != 0 ? toolsets : toolsets.ToList (); }
242 public Toolset GetToolset (string toolsVersion)
244 return Toolsets.FirstOrDefault (t => t.ToolsVersion == toolsVersion);
247 //FIXME: should also support config file, depending on ToolsetLocations
248 void LoadDefaultToolsets ()
250 AddToolset (new Toolset ("4.0",
251 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version40), this, null));
253 AddToolset (new Toolset ("12.0", ToolLocationHelper.GetPathToBuildTools ("12.0"), this, null));
256 AddToolset (new Toolset ("14.0", ToolLocationHelper.GetPathToBuildTools ("14.0"), this, null));
259 // We don't support these anymore
260 AddToolset (new Toolset ("2.0",
261 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version20), this, null));
262 AddToolset (new Toolset ("3.0",
263 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version30), this, null));
264 AddToolset (new Toolset ("3.5",
265 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version35), this, null));
267 default_tools_version = toolsets [0].ToolsVersion;
270 [MonoTODO ("not verified at all")]
271 public void AddToolset (Toolset toolset)
273 toolsets.Add (toolset);
276 [MonoTODO ("not verified at all")]
277 public void RemoveAllToolsets ()
282 public void RegisterLogger (ILogger logger)
284 loggers.Add (logger);
287 public void RegisterLoggers (IEnumerable<ILogger> loggers)
289 foreach (var logger in loggers)
290 this.loggers.Add (logger);
293 public void UnloadAllProjects ()
295 throw new NotImplementedException ();
298 [MonoTODO ("Not verified at all")]
299 public void UnloadProject (Project project)
301 this.loaded_projects.Remove (project);
304 [MonoTODO ("Not verified at all")]
305 public void UnloadProject (ProjectRootElement projectRootElement)
307 foreach (var proj in loaded_projects.Where (p => p.Xml == projectRootElement).ToArray ())
308 UnloadProject (proj);
311 public static Version Version {
312 get { throw new NotImplementedException (); }
318 public bool DisableMarkDirty { get; set; }
321 public HostServices HostServices { get; set; }
324 public bool IsBuildEnabled { get; set; }
326 internal string BuildStartupDirectory { get; set; }
328 internal int MaxNodeCount { get; private set; }
330 Stack<string> ongoing_imports = new Stack<string> ();
332 internal Stack<string> OngoingImports {
333 get { return ongoing_imports; }
337 internal static IEnumerable<EnvironmentProjectProperty> GetWellKnownProperties (Project project)
339 Func<string,string,EnvironmentProjectProperty> create = (name, value) => new EnvironmentProjectProperty (project, name, value, true);
340 return GetWellKnownProperties (create);
343 internal static IEnumerable<ProjectPropertyInstance> GetWellKnownProperties (ProjectInstance project)
345 Func<string,string,ProjectPropertyInstance> create = (name, value) => new ProjectPropertyInstance (name, true, value);
346 return GetWellKnownProperties (create);
349 static IEnumerable<T> GetWellKnownProperties<T> (Func<string,string,T> create)
351 yield return create ("OS", OS);
352 var ext = Environment.GetEnvironmentVariable ("MSBuildExtensionsPath") ?? DefaultExtensionsPath;
353 yield return create ("MSBuildExtensionsPath", ext);
354 var ext32 = Environment.GetEnvironmentVariable ("MSBuildExtensionsPath32") ?? ext;
355 yield return create ("MSBuildExtensionsPath32", ext32);
356 var ext64 = Environment.GetEnvironmentVariable ("MSBuildExtensionsPath64") ?? ext;
357 yield return create ("MSBuildExtensionsPath64", ext64);
362 PlatformID pid = Environment.OSVersion.Platform;
375 #region Extension Paths resolution
377 static string extensions_path;
378 internal static string DefaultExtensionsPath {
380 if (extensions_path == null) {
381 // NOTE: code from mcs/tools/gacutil/driver.cs
382 PropertyInfo gac = typeof (System.Environment).GetProperty (
383 "GacPath", BindingFlags.Static | BindingFlags.NonPublic);
386 MethodInfo get_gac = gac.GetGetMethod (true);
387 string gac_path = (string) get_gac.Invoke (null, null);
388 extensions_path = Path.GetFullPath (Path.Combine (
389 gac_path, Path.Combine ("..", "xbuild")));
392 return extensions_path;
396 static string DotConfigExtensionsPath = Path.Combine (Environment.GetFolderPath (Environment.SpecialFolder.ApplicationData),
397 Path.Combine ("xbuild", "tasks"));
398 const string MacOSXExternalXBuildDir = "/Library/Frameworks/Mono.framework/External/xbuild";
399 static string PathSeparatorAsString = Path.PathSeparator.ToString ();
401 // Gives a list of extensions paths to try for $(MSBuildExtensionsPath),
403 internal static IEnumerable<string> GetApplicableExtensionsPaths (Action<string> logMessage)
405 string envvar = String.Join (PathSeparatorAsString, new string [] {
406 // For mac osx, look in the 'External' dir on macosx,
408 MSBuildUtils.RunningOnMac ? MacOSXExternalXBuildDir : String.Empty,
409 DotConfigExtensionsPath,
410 DefaultExtensionsPath});
412 var pathsTable = new Dictionary<string, string> ();
413 foreach (string extn_path in envvar.Split (new char [] {Path.PathSeparator}, StringSplitOptions.RemoveEmptyEntries)) {
414 if (pathsTable.ContainsKey (extn_path))
417 if (!Directory.Exists (extn_path)) {
418 logMessage (string.Format ("Extension path '{0}' not found, ignoring.", extn_path));
422 pathsTable [extn_path] = extn_path;
423 yield return extn_path;
427 internal static string FindFileInSeveralExtensionsPath (ref string extensionsPathOverride, Func<string,string> expandString, string file, Action<string> logMessage)
430 string ex = extensionsPathOverride;
431 Func<bool> action = () => {
432 string path = WindowsCompatibilityExtensions.FindMatchingPath (expandString (file));
433 if (File.Exists (path))
442 foreach (var s in ProjectCollection.GetApplicableExtensionsPaths (logMessage)) {
443 extensionsPathOverride = s;
450 extensionsPathOverride = null;
453 return ret ?? WindowsCompatibilityExtensions.FindMatchingPath (expandString (file));
458 internal IEnumerable<ReservedProjectProperty> GetReservedProperties (Toolset toolset, Project project)
460 Func<string,Func<string>,ReservedProjectProperty> create = (name, value) => new ReservedProjectProperty (project, name, value);
461 return GetReservedProperties<ReservedProjectProperty> (toolset, project.Xml, create, () => project.FullPath);
464 internal IEnumerable<ProjectPropertyInstance> GetReservedProperties (Toolset toolset, ProjectInstance project, ProjectRootElement xml)
466 Func<string,Func<string>,ProjectPropertyInstance> create = (name, value) => new ProjectPropertyInstance (name, true, null, value);
467 return GetReservedProperties<ProjectPropertyInstance> (toolset, xml, create, () => project.FullPath);
470 // seealso http://msdn.microsoft.com/en-us/library/ms164309.aspx
471 IEnumerable<T> GetReservedProperties<T> (Toolset toolset, ProjectRootElement project, Func<string,Func<string>,T> create, Func<string> projectFullPath)
473 yield return create ("MSBuildBinPath", () => toolset.ToolsPath);
474 // FIXME: add MSBuildLastTaskResult
475 // FIXME: add MSBuildNodeCount
476 // FIXME: add MSBuildProgramFiles32
477 yield return create ("MSBuildProjectDefaultTargets", () => project.DefaultTargets);
478 yield return create ("MSBuildProjectDirectory", () => project.DirectoryPath + Path.DirectorySeparatorChar);
479 yield return create ("MSBuildProjectDirectoryNoRoot", () => project.DirectoryPath.Substring (Path.GetPathRoot (project.DirectoryPath).Length));
480 yield return create ("MSBuildProjectExtension", () => Path.GetExtension (project.FullPath));
481 yield return create ("MSBuildProjectFile", () => Path.GetFileName (project.FullPath));
482 yield return create ("MSBuildProjectFullPath", () => project.FullPath);
483 yield return create ("MSBuildProjectName", () => Path.GetFileNameWithoutExtension (project.FullPath));
484 yield return create ("MSBuildStartupDirectory", () => BuildStartupDirectory);
485 yield return create ("MSBuildThisFile", () => Path.GetFileName (GetEvaluationTimeThisFile (projectFullPath)));
486 yield return create ("MSBuildThisFileFullPath", () => GetEvaluationTimeThisFile (projectFullPath));
487 yield return create ("MSBuildThisFileName", () => Path.GetFileNameWithoutExtension (GetEvaluationTimeThisFile (projectFullPath)));
488 yield return create ("MSBuildThisFileExtension", () => Path.GetExtension (GetEvaluationTimeThisFile (projectFullPath)));
490 yield return create ("MSBuildThisFileDirectory", () => Path.GetDirectoryName (GetEvaluationTimeThisFileDirectory (projectFullPath)));
491 yield return create ("MSBuildThisFileDirectoryNoRoot", () => {
492 string dir = GetEvaluationTimeThisFileDirectory (projectFullPath) + Path.DirectorySeparatorChar;
493 return dir.Substring (Path.GetPathRoot (dir).Length);
495 yield return create ("MSBuildToolsPath", () => toolset.ToolsPath);
496 yield return create ("MSBuildToolsVersion", () => toolset.ToolsVersion);
498 // This is an implementation specific special property for this Microsoft.Build.dll to differentiate
499 // the build from Microsoft.Build.Engine.dll. It is significantly used in some *.targets file we share
500 // between old and new build engine.
501 yield return create ("MonoUseMicrosoftBuildDll", () => "True");
504 // These are required for reserved property, represents dynamically changing property values.
505 // This should resolve to either the project file path or that of the imported file.
506 internal string GetEvaluationTimeThisFileDirectory (Func<string> nonImportingTimeFullPath)
508 var file = GetEvaluationTimeThisFile (nonImportingTimeFullPath);
509 var dir = Path.IsPathRooted (file) ? Path.GetDirectoryName (file) : Directory.GetCurrentDirectory ();
510 return dir + Path.DirectorySeparatorChar;
513 internal string GetEvaluationTimeThisFile (Func<string> nonImportingTimeFullPath)
515 return OngoingImports.Count > 0 ? OngoingImports.Peek () : (nonImportingTimeFullPath () ?? string.Empty);
518 static readonly char [] item_target_sep = {';'};
520 internal static IEnumerable<T> GetAllItems<T> (Func<string,string> expandString, string include, string exclude, Func<string,T> creator, Func<string,ITaskItem> taskItemCreator, string directory, Action<T,string> assignRecurse, Func<ITaskItem,bool> isDuplicate)
522 var includes = expandString (include).Trim ().Split (item_target_sep, StringSplitOptions.RemoveEmptyEntries);
523 var excludes = expandString (exclude).Trim ().Split (item_target_sep, StringSplitOptions.RemoveEmptyEntries);
525 if (includes.Length == 0)
527 if (includes.Length == 1 && includes [0].IndexOf ('*') < 0 && excludes.Length == 0) {
528 // for most case - shortcut.
529 var item = creator (includes [0]);
532 var ds = new Microsoft.Build.BuildEngine.DirectoryScanner () {
533 BaseDirectory = new DirectoryInfo (directory),
534 Includes = includes.Where (s => !string.IsNullOrWhiteSpace (s)).Select (i => taskItemCreator (i)).ToArray (),
535 Excludes = excludes.Where (s => !string.IsNullOrWhiteSpace (s)).Select (e => taskItemCreator (e)).ToArray (),
538 foreach (var taskItem in ds.MatchedItems) {
539 if (isDuplicate (taskItem))
540 continue; // skip duplicate
541 var item = creator (taskItem.ItemSpec);
542 string recurse = taskItem.GetMetadata ("RecursiveDir");
543 assignRecurse (item, recurse);
549 static readonly char [] path_sep = {Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar};
551 internal static string GetWellKnownMetadata (string name, string file, Func<string,string> getFullPath, string recursiveDir)
553 switch (name.ToLower (CultureInfo.InvariantCulture)) {
555 return getFullPath (file);
557 return Path.GetPathRoot (getFullPath (file));
559 return Path.GetFileNameWithoutExtension (file);
561 return Path.GetExtension (file);
563 var idx = file.LastIndexOfAny (path_sep);
564 return idx < 0 ? string.Empty : file.Substring (0, idx + 1);
566 var fp = getFullPath (file);
567 return Path.GetDirectoryName (fp).Substring (Path.GetPathRoot (fp).Length);
573 return new FileInfo (getFullPath (file)).LastWriteTime.ToString ("yyyy-MM-dd HH:mm:ss.fffffff");
575 return new FileInfo (getFullPath (file)).CreationTime.ToString ("yyyy-MM-dd HH:mm:ss.fffffff");
577 return new FileInfo (getFullPath (file)).LastAccessTime.ToString ("yyyy-MM-dd HH:mm:ss.fffffff");