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;
46 namespace Microsoft.Build.Evaluation
48 public class ProjectCollection : IDisposable
50 public delegate void ProjectAddedEventHandler (object target, ProjectAddedToProjectCollectionEventArgs args);
52 public class ProjectAddedToProjectCollectionEventArgs : EventArgs
54 public ProjectAddedToProjectCollectionEventArgs (ProjectRootElement project)
57 throw new ArgumentNullException ("project");
58 ProjectRootElement = project;
61 public ProjectRootElement ProjectRootElement { get; private set; }
66 static readonly ProjectCollection global_project_collection;
68 static ProjectCollection ()
71 global_project_collection = new ProjectCollection (new ReadOnlyDictionary<string, string> (new Dictionary<string, string> ()));
73 global_project_collection = new ProjectCollection (new Dictionary<string, string> ());
77 public static string Escape (string unescapedString)
79 return Mono.XBuild.Utilities.MSBuildUtils.Escape (unescapedString);
82 public static string Unescape (string escapedString)
84 return Mono.XBuild.Utilities.MSBuildUtils.Unescape (escapedString);
87 public static ProjectCollection GlobalProjectCollection {
88 get { return global_project_collection; }
91 // semantic model part
93 public ProjectCollection ()
98 public ProjectCollection (IDictionary<string, string> globalProperties)
99 : this (globalProperties, null, ToolsetDefinitionLocations.Registry | ToolsetDefinitionLocations.ConfigurationFile)
103 public ProjectCollection (ToolsetDefinitionLocations toolsetDefinitionLocations)
104 : this (null, null, toolsetDefinitionLocations)
108 public ProjectCollection (IDictionary<string, string> globalProperties, IEnumerable<ILogger> loggers,
109 ToolsetDefinitionLocations toolsetDefinitionLocations)
110 : this (globalProperties, loggers, null, toolsetDefinitionLocations, 1, false)
114 public ProjectCollection (IDictionary<string, string> globalProperties,
115 IEnumerable<ILogger> loggers, IEnumerable<ForwardingLoggerRecord> remoteLoggers,
116 ToolsetDefinitionLocations toolsetDefinitionLocations,
117 int maxNodeCount, bool onlyLogCriticalEvents)
119 global_properties = globalProperties ?? new Dictionary<string, string> ();
120 this.loggers = loggers != null ? loggers.ToList () : new List<ILogger> ();
121 toolset_locations = toolsetDefinitionLocations;
122 MaxNodeCount = maxNodeCount;
123 OnlyLogCriticalEvents = onlyLogCriticalEvents;
125 LoadDefaultToolsets ();
128 [MonoTODO ("not fired yet")]
129 public event ProjectAddedEventHandler ProjectAdded;
130 [MonoTODO ("not fired yet")]
131 public event EventHandler<ProjectChangedEventArgs> ProjectChanged;
132 [MonoTODO ("not fired yet")]
133 public event EventHandler<ProjectCollectionChangedEventArgs> ProjectCollectionChanged;
134 [MonoTODO ("not fired yet")]
135 public event EventHandler<ProjectXmlChangedEventArgs> ProjectXmlChanged;
137 public void AddProject (Project project)
139 this.loaded_projects.Add (project);
140 if (ProjectAdded != null)
141 ProjectAdded (this, new ProjectAddedToProjectCollectionEventArgs (project.Xml));
145 get { return loaded_projects.Count; }
148 string default_tools_version;
149 public string DefaultToolsVersion {
150 get { return default_tools_version; }
152 if (GetToolset (value) == null)
153 throw new InvalidOperationException (string.Format ("Toolset '{0}' does not exist", value));
154 default_tools_version = value;
158 public void Dispose ()
161 GC.SuppressFinalize (this);
164 protected virtual void Dispose (bool disposing)
170 public ICollection<Project> GetLoadedProjects (string fullPath)
172 return LoadedProjects.Where (p => p.FullPath != null && Path.GetFullPath (p.FullPath) == Path.GetFullPath (fullPath)).ToList ();
175 readonly IDictionary<string, string> global_properties;
177 public IDictionary<string, string> GlobalProperties {
178 get { return global_properties; }
181 readonly List<Project> loaded_projects = new List<Project> ();
183 public Project LoadProject (string fileName)
185 return LoadProject (fileName, DefaultToolsVersion);
188 public Project LoadProject (string fileName, string toolsVersion)
190 return LoadProject (fileName, null, toolsVersion);
193 public Project LoadProject (string fileName, IDictionary<string,string> globalProperties, string toolsVersion)
195 var ret = new Project (fileName, globalProperties, toolsVersion);
196 loaded_projects.Add (ret);
200 // These methods somehow don't add the project to ProjectCollection...
201 public Project LoadProject (XmlReader xmlReader)
203 return LoadProject (xmlReader, DefaultToolsVersion);
206 public Project LoadProject (XmlReader xmlReader, string toolsVersion)
208 return LoadProject (xmlReader, null, toolsVersion);
211 public Project LoadProject (XmlReader xmlReader, IDictionary<string,string> globalProperties, string toolsVersion)
213 return new Project (xmlReader, globalProperties, toolsVersion);
216 public ICollection<Project> LoadedProjects {
217 get { return loaded_projects; }
220 readonly List<ILogger> loggers = new List<ILogger> ();
222 public ICollection<ILogger> Loggers {
223 get { return loggers; }
227 public bool OnlyLogCriticalEvents { get; set; }
230 public bool SkipEvaluation { get; set; }
232 readonly ToolsetDefinitionLocations toolset_locations;
233 public ToolsetDefinitionLocations ToolsetLocations {
234 get { return toolset_locations; }
237 readonly List<Toolset> toolsets = new List<Toolset> ();
238 // so what should we do without ToolLocationHelper in Microsoft.Build.Utilities.dll? There is no reference to it in this dll.
239 public ICollection<Toolset> Toolsets {
240 // For ConfigurationFile and None, they cannot be added externally.
241 get { return (ToolsetLocations & ToolsetDefinitionLocations.Registry) != 0 ? toolsets : toolsets.ToList (); }
244 public Toolset GetToolset (string toolsVersion)
246 return Toolsets.FirstOrDefault (t => t.ToolsVersion == toolsVersion);
249 //FIXME: should also support config file, depending on ToolsetLocations
250 void LoadDefaultToolsets ()
252 AddToolset (new Toolset ("2.0",
253 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version20), this, null));
254 AddToolset (new Toolset ("3.0",
255 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version30), this, null));
256 AddToolset (new Toolset ("3.5",
257 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version35), this, null));
259 AddToolset (new Toolset ("4.0",
260 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version40), this, null));
263 AddToolset (new Toolset ("12.0", ToolLocationHelper.GetPathToBuildTools ("12.0"), this, null));
265 default_tools_version = toolsets.First ().ToolsVersion;
268 [MonoTODO ("not verified at all")]
269 public void AddToolset (Toolset toolset)
271 toolsets.Add (toolset);
274 [MonoTODO ("not verified at all")]
275 public void RemoveAllToolsets ()
280 public void RegisterLogger (ILogger logger)
282 loggers.Add (logger);
285 public void RegisterLoggers (IEnumerable<ILogger> loggers)
287 foreach (var logger in loggers)
288 this.loggers.Add (logger);
291 public void UnloadAllProjects ()
293 throw new NotImplementedException ();
296 [MonoTODO ("Not verified at all")]
297 public void UnloadProject (Project project)
299 this.loaded_projects.Remove (project);
302 [MonoTODO ("Not verified at all")]
303 public void UnloadProject (ProjectRootElement projectRootElement)
305 foreach (var proj in loaded_projects.Where (p => p.Xml == projectRootElement).ToArray ())
306 UnloadProject (proj);
309 public static Version Version {
310 get { throw new NotImplementedException (); }
316 public bool DisableMarkDirty { get; set; }
319 public HostServices HostServices { get; set; }
322 public bool IsBuildEnabled { get; set; }
324 internal string BuildStartupDirectory { get; set; }
326 internal int MaxNodeCount { get; private set; }
328 Stack<string> ongoing_imports = new Stack<string> ();
330 internal Stack<string> OngoingImports {
331 get { return ongoing_imports; }
335 internal static IEnumerable<EnvironmentProjectProperty> GetWellKnownProperties (Project project)
337 Func<string,string,EnvironmentProjectProperty> create = (name, value) => new EnvironmentProjectProperty (project, name, value, true);
338 return GetWellKnownProperties (create);
341 internal static IEnumerable<ProjectPropertyInstance> GetWellKnownProperties (ProjectInstance project)
343 Func<string,string,ProjectPropertyInstance> create = (name, value) => new ProjectPropertyInstance (name, true, value);
344 return GetWellKnownProperties (create);
347 static IEnumerable<T> GetWellKnownProperties<T> (Func<string,string,T> create)
349 var ext = Environment.GetEnvironmentVariable ("MSBuildExtensionsPath") ?? DefaultExtensionsPath;
350 yield return create ("MSBuildExtensionsPath", ext);
351 var ext32 = Environment.GetEnvironmentVariable ("MSBuildExtensionsPath32") ?? ext;
352 yield return create ("MSBuildExtensionsPath32", ext32);
353 var ext64 = Environment.GetEnvironmentVariable ("MSBuildExtensionsPath64") ?? ext;
354 yield return create ("MSBuildExtensionsPath64", ext64);
357 static string extensions_path;
358 internal static string DefaultExtensionsPath {
360 if (extensions_path == null) {
361 // NOTE: code from mcs/tools/gacutil/driver.cs
362 PropertyInfo gac = typeof (System.Environment).GetProperty (
363 "GacPath", BindingFlags.Static | BindingFlags.NonPublic);
366 MethodInfo get_gac = gac.GetGetMethod (true);
367 string gac_path = (string) get_gac.Invoke (null, null);
368 extensions_path = Path.GetFullPath (Path.Combine (
369 gac_path, Path.Combine ("..", "xbuild")));
372 return extensions_path;
376 internal IEnumerable<ReservedProjectProperty> GetReservedProperties (Toolset toolset, Project project)
378 Func<string,Func<string>,ReservedProjectProperty> create = (name, value) => new ReservedProjectProperty (project, name, value);
379 return GetReservedProperties<ReservedProjectProperty> (toolset, project.Xml, create, () => project.FullPath);
382 internal IEnumerable<ProjectPropertyInstance> GetReservedProperties (Toolset toolset, ProjectInstance project, ProjectRootElement xml)
384 Func<string,Func<string>,ProjectPropertyInstance> create = (name, value) => new ProjectPropertyInstance (name, true, null, value);
385 return GetReservedProperties<ProjectPropertyInstance> (toolset, xml, create, () => project.FullPath);
388 // seealso http://msdn.microsoft.com/en-us/library/ms164309.aspx
389 IEnumerable<T> GetReservedProperties<T> (Toolset toolset, ProjectRootElement project, Func<string,Func<string>,T> create, Func<string> projectFullPath)
391 yield return create ("MSBuildBinPath", () => toolset.ToolsPath);
392 // FIXME: add MSBuildLastTaskResult
393 // FIXME: add MSBuildNodeCount
394 // FIXME: add MSBuildProgramFiles32
395 yield return create ("MSBuildProjectDefaultTargets", () => project.DefaultTargets);
396 yield return create ("MSBuildProjectDirectory", () => project.DirectoryPath + Path.DirectorySeparatorChar);
397 yield return create ("MSBuildProjectDirectoryNoRoot", () => project.DirectoryPath.Substring (Path.GetPathRoot (project.DirectoryPath).Length));
398 yield return create ("MSBuildProjectExtension", () => Path.GetExtension (project.FullPath));
399 yield return create ("MSBuildProjectFile", () => Path.GetFileName (project.FullPath));
400 yield return create ("MSBuildProjectFullPath", () => project.FullPath);
401 yield return create ("MSBuildProjectName", () => Path.GetFileNameWithoutExtension (project.FullPath));
402 yield return create ("MSBuildStartupDirectory", () => BuildStartupDirectory);
403 yield return create ("MSBuildThisFile", () => Path.GetFileName (GetEvaluationTimeThisFile (projectFullPath)));
404 yield return create ("MSBuildThisFileFullPath", () => GetEvaluationTimeThisFile (projectFullPath));
405 yield return create ("MSBuildThisFileName", () => Path.GetFileNameWithoutExtension (GetEvaluationTimeThisFile (projectFullPath)));
406 yield return create ("MSBuildThisFileExtension", () => Path.GetExtension (GetEvaluationTimeThisFile (projectFullPath)));
408 yield return create ("MSBuildThisFileDirectory", () => Path.GetDirectoryName (GetEvaluationTimeThisFileDirectory (projectFullPath)));
409 yield return create ("MSBuildThisFileDirectoryNoRoot", () => {
410 string dir = GetEvaluationTimeThisFileDirectory (projectFullPath) + Path.DirectorySeparatorChar;
411 return dir.Substring (Path.GetPathRoot (dir).Length);
413 yield return create ("MSBuildToolsPath", () => toolset.ToolsPath);
414 yield return create ("MSBuildToolsVersion", () => toolset.ToolsVersion);
417 // These are required for reserved property, represents dynamically changing property values.
418 // This should resolve to either the project file path or that of the imported file.
419 internal string GetEvaluationTimeThisFileDirectory (Func<string> nonImportingTimeFullPath)
421 var file = GetEvaluationTimeThisFile (nonImportingTimeFullPath);
422 var dir = Path.IsPathRooted (file) ? Path.GetDirectoryName (file) : Directory.GetCurrentDirectory ();
423 return dir + Path.DirectorySeparatorChar;
426 internal string GetEvaluationTimeThisFile (Func<string> nonImportingTimeFullPath)
428 return OngoingImports.Count > 0 ? OngoingImports.Peek () : (nonImportingTimeFullPath () ?? string.Empty);
431 static readonly char [] item_target_sep = {';'};
433 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)
435 var includes = expandString (include).Trim ().Split (item_target_sep, StringSplitOptions.RemoveEmptyEntries);
436 var excludes = expandString (exclude).Trim ().Split (item_target_sep, StringSplitOptions.RemoveEmptyEntries);
438 if (includes.Length == 0)
440 if (includes.Length == 1 && includes [0].IndexOf ('*') < 0 && excludes.Length == 0) {
441 // for most case - shortcut.
442 var item = creator (includes [0]);
445 var ds = new Microsoft.Build.BuildEngine.DirectoryScanner () {
446 BaseDirectory = new DirectoryInfo (directory),
447 Includes = includes.Where (s => !string.IsNullOrWhiteSpace (s)).Select (i => taskItemCreator (i)).ToArray (),
448 Excludes = excludes.Where (s => !string.IsNullOrWhiteSpace (s)).Select (e => taskItemCreator (e)).ToArray (),
451 foreach (var taskItem in ds.MatchedItems) {
452 if (isDuplicate (taskItem))
453 continue; // skip duplicate
454 var item = creator (taskItem.ItemSpec);
455 string recurse = taskItem.GetMetadata ("RecursiveDir");
456 assignRecurse (item, recurse);
462 static readonly char [] path_sep = {Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar};
464 internal static string GetWellKnownMetadata (string name, string file, Func<string,string> getFullPath, string recursiveDir)
466 switch (name.ToLower (CultureInfo.InvariantCulture)) {
468 return getFullPath (file);
470 return Path.GetPathRoot (getFullPath (file));
472 return Path.GetFileNameWithoutExtension (file);
474 return Path.GetExtension (file);
476 var idx = file.LastIndexOfAny (path_sep);
477 return idx < 0 ? string.Empty : file.Substring (0, idx + 1);
479 var fp = getFullPath (file);
480 return Path.GetDirectoryName (fp).Substring (Path.GetPathRoot (fp).Length);
486 return new FileInfo (getFullPath (file)).LastWriteTime.ToString ("yyyy-MM-dd HH:mm:ss.fffffff");
488 return new FileInfo (getFullPath (file)).CreationTime.ToString ("yyyy-MM-dd HH:mm:ss.fffffff");
490 return new FileInfo (getFullPath (file)).LastAccessTime.ToString ("yyyy-MM-dd HH:mm:ss.fffffff");