mcs/class/Microsoft.Build.Engine/Microsoft.Build.BuildEngine/Engine.cs

   1 //
   2 // Engine.cs: Main engine of XBuild.
   3 //
   4 // Author:
   5 //   Marek Sieradzki (marek.sieradzki@gmail.com)
   6 //
   7 // (C) 2005 Marek Sieradzki
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27
  28 using System;
  29 using System.Collections;
  30 using System.Collections.Generic;
  31 using System.IO;
  32 using System.Linq;
  33 using Microsoft.Build.Framework;
  34 using Microsoft.Build.Utilities;
  35 using Mono.XBuild.Utilities;
  36
  37 namespace Microsoft.Build.BuildEngine {
  38         public class Engine {
  39
  40                 string                  binPath;
  41                 bool                    buildEnabled;
  42                 Dictionary<string, TaskDatabase> defaultTasksTableByToolsVersion;
  43                 const string            defaultTasksProjectName = "Microsoft.Common.tasks";
  44                 EventSource             eventSource;
  45                 bool                    buildStarted;
  46                 //ToolsetDefinitionLocations toolsetLocations;
  47                 BuildPropertyGroup      global_properties;
  48                 //IDictionary           importedProjects;
  49                 List <ILogger>          loggers;
  50                 //bool                  onlyLogCriticalEvents;
  51                 Dictionary <string, Project>    projects;
  52                 string defaultToolsVersion;
  53
  54                 // the key here represents the project+target+global_properties set
  55                 Dictionary <string, ITaskItem[]> builtTargetsOutputByName;
  56                 Stack<Project> currentlyBuildingProjectsStack;
  57
  58                 static Engine           globalEngine;
  59                 static Version          version;
  60
  61                 static Engine ()
  62                 {
  63                         version = new Version ("0.1");
  64                 }
  65
  66                 public Engine ()
  67                         : this (ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version20))
  68                 {
  69                 }
  70
  71                 public Engine (ToolsetDefinitionLocations locations)
  72                         : this (ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version20))
  73                 {
  74                         //toolsetLocations = locations;
  75                 }
  76
  77                 public Engine (BuildPropertyGroup globalProperties)
  78                         : this (ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version20))
  79                 {
  80                         this.global_properties = globalProperties;
  81                 }
  82
  83                 public Engine (BuildPropertyGroup globalProperties, ToolsetDefinitionLocations locations)
  84                         : this (ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version20))
  85                 {
  86                         this.global_properties = globalProperties;
  87                         //toolsetLocations = locations;
  88                 }
  89
  90                 // engine should be invoked with path where binary files are
  91                 // to find microsoft.build.tasks
  92                 public Engine (string binPath)
  93                 {
  94                         this.binPath = binPath;
  95                         this.buildEnabled = true;
  96                         this.projects = new Dictionary <string, Project> ();
  97                         this.eventSource = new EventSource ();
  98                         this.loggers = new List <ILogger> ();
  99                         this.buildStarted = false;
 100                         this.global_properties = new BuildPropertyGroup ();
 101                         this.builtTargetsOutputByName = new Dictionary<string, ITaskItem[]> ();
 102                         this.currentlyBuildingProjectsStack = new Stack<Project> ();
 103                         this.Toolsets = new ToolsetCollection ();
 104                         LoadDefaultToolsets ();
 105                         defaultTasksTableByToolsVersion = new Dictionary<string, TaskDatabase> ();
 106                 }
 107
 108                 //FIXME: should be loaded from config file
 109                 void LoadDefaultToolsets ()
 110                 {
 111                         Toolsets.Add (new Toolset ("2.0",
 112                                                 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version20)));
 113                         Toolsets.Add (new Toolset ("3.0",
 114                                                 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version30)));
 115                         Toolsets.Add (new Toolset ("3.5",
 116                                                 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version35)));
 117 #if NET_4_0
 118                         Toolsets.Add (new Toolset ("4.0",
 119                                                 ToolLocationHelper.GetPathToDotNetFramework (TargetDotNetFrameworkVersion.Version40)));
 120 #endif
 121                 }
 122
 123                 [MonoTODO]
 124                 public bool BuildProject (Project project)
 125                 {
 126                         if (project == null)
 127                                 throw new ArgumentException ("project");
 128                         builtTargetsOutputByName.Clear ();
 129                         return project.Build ();
 130                 }
 131
 132                 [MonoTODO]
 133                 public bool BuildProject (Project project, string targetName)
 134                 {
 135                         if (project == null)
 136                                 throw new ArgumentException ("project");
 137                         if (targetName == null)
 138                                 return false;
 139
 140                         return BuildProject (project, new string[] { targetName}, null, BuildSettings.None);
 141                 }
 142
 143                 [MonoTODO]
 144                 public bool BuildProject (Project project, string[] targetNames)
 145                 {
 146                         return BuildProject (project, targetNames, null, BuildSettings.None);
 147                 }
 148
 149                 [MonoTODO]
 150                 public bool BuildProject (Project project,
 151                                           string[] targetNames,
 152                                           IDictionary targetOutputs)
 153                 {
 154                         return BuildProject (project, targetNames, targetOutputs, BuildSettings.None);
 155                 }
 156
 157                 public bool BuildProject (Project project,
 158                                           string[] targetNames,
 159                                           IDictionary targetOutputs,
 160                                           BuildSettings buildFlags)
 161                 {
 162                         if (project == null)
 163                                 throw new ArgumentException ("project");
 164                         if (targetNames == null)
 165                                 return false;
 166
 167                         if ((buildFlags & BuildSettings.DoNotResetPreviouslyBuiltTargets) != BuildSettings.DoNotResetPreviouslyBuiltTargets)
 168                                 builtTargetsOutputByName.Clear ();
 169
 170                         if (defaultToolsVersion != null)
 171                                 // it has been explicitly set, xbuild does this..
 172                                 project.ToolsVersion = defaultToolsVersion;
 173                         return project.Build (targetNames, targetOutputs, buildFlags);
 174                 }
 175
 176                 [MonoTODO]
 177                 public bool BuildProjectFile (string projectFile)
 178                 {
 179                         return BuildProjectFile (projectFile, new string [0]);
 180                 }
 181
 182                 [MonoTODO]
 183                 public bool BuildProjectFile (string projectFile,
 184                                               string targetName)
 185                 {
 186                         return BuildProjectFile (projectFile,
 187                                                  targetName == null ? new string [0] : new string [] {targetName});
 188                 }
 189
 190                 [MonoTODO]
 191                 public bool BuildProjectFile (string projectFile,
 192                                               string[] targetNames)
 193                 {
 194                         return BuildProjectFile (projectFile, targetNames, null);
 195                 }
 196
 197                 [MonoTODO]
 198                 public bool BuildProjectFile (string projectFile,
 199                                               string[] targetNames,
 200                                               BuildPropertyGroup globalProperties)
 201                 {
 202                         return BuildProjectFile (projectFile, targetNames, globalProperties, null, BuildSettings.None);
 203                 }
 204
 205                 [MonoTODO]
 206                 public bool BuildProjectFile (string projectFile,
 207                                               string[] targetNames,
 208                                               BuildPropertyGroup globalProperties,
 209                                               IDictionary targetOutputs)
 210                 {
 211                         return BuildProjectFile (projectFile, targetNames, globalProperties, targetOutputs, BuildSettings.None);
 212                 }
 213
 214                 public bool BuildProjectFile (string projectFile,
 215                                               string[] targetNames,
 216                                               BuildPropertyGroup globalProperties,
 217                                               IDictionary targetOutputs,
 218                                               BuildSettings buildFlags)
 219                 {
 220                         return BuildProjectFile (projectFile, targetNames, globalProperties, targetOutputs, buildFlags, null);
 221                 }
 222
 223                 //FIXME: add a test for null @toolsVersion
 224                 public bool BuildProjectFile (string projectFile,
 225                                               string[] targetNames,
 226                                               BuildPropertyGroup globalProperties,
 227                                               IDictionary targetOutputs,
 228                                               BuildSettings buildFlags, string toolsVersion)
 229                 {
 230                         bool result = false;
 231                         try {
 232                                 StartEngineBuild ();
 233                                 result = BuildProjectFileInternal (projectFile, targetNames, globalProperties, targetOutputs, buildFlags, toolsVersion);
 234                                 return result;
 235                         } catch (InvalidProjectFileException ie) {
 236                                 this.LogErrorWithFilename (projectFile, ie.Message);
 237                                 this.LogMessage (MessageImportance.Low, String.Format ("{0}: {1}", projectFile, ie.ToString ()));
 238                                 return false;
 239                         } catch (Exception e) {
 240                                 if (buildStarted) {
 241                                         this.LogErrorWithFilename (projectFile, e.Message);
 242                                         this.LogMessage (MessageImportance.Low, String.Format ("{0}: {1}", projectFile, e.ToString ()));
 243                                 }
 244                                 throw;
 245                         } finally {
 246                                 EndEngineBuild (result);
 247                         }
 248                 }
 249
 250                 bool BuildProjectFileInternal (string projectFile,
 251                                               string[] targetNames,
 252                                               BuildPropertyGroup globalProperties,
 253                                               IDictionary targetOutputs,
 254                                               BuildSettings buildFlags, string toolsVersion)
 255                 {
 256
 257                         if ((buildFlags & BuildSettings.DoNotResetPreviouslyBuiltTargets) != BuildSettings.DoNotResetPreviouslyBuiltTargets)
 258                                 builtTargetsOutputByName.Clear ();
 259
 260                         Project project;
 261
 262                         bool newProject = false;
 263                         if (!projects.TryGetValue (projectFile, out project)) {
 264                                 project = CreateNewProject ();
 265                                 newProject = true;
 266                         }
 267
 268                         BuildPropertyGroup engine_old_grp = null;
 269                         BuildPropertyGroup project_old_grp = null;
 270                         if (globalProperties != null) {
 271                                 engine_old_grp = GlobalProperties.Clone (true);
 272                                 project_old_grp = project.GlobalProperties.Clone (true);
 273
 274                                 // Override project's global properties with the
 275                                 // ones explicitlcur_y specified here
 276                                 foreach (BuildProperty bp in globalProperties)
 277                                         project.GlobalProperties.AddProperty (bp);
 278
 279                                 if (!newProject)
 280                                         project.NeedToReevaluate ();
 281                         }
 282
 283                         if (newProject)
 284                                 project.Load (projectFile);
 285
 286                         try {
 287                                 string oldProjectToolsVersion = project.ToolsVersion;
 288                                 if (String.IsNullOrEmpty (toolsVersion) && defaultToolsVersion != null)
 289                                         // no tv specified, let the project inherit it from the
 290                                         // engine. 'defaultToolsVersion' will be effective only
 291                                         // it has been overridden. Otherwise, the project's own
 292                                         // tv will be used.
 293                                         project.ToolsVersion = defaultToolsVersion;
 294                                 else
 295                                         project.ToolsVersion = toolsVersion;
 296
 297                                 try {
 298                                         return project.Build (targetNames, targetOutputs, buildFlags);
 299                                 } finally {
 300                                         project.ToolsVersion = oldProjectToolsVersion;
 301                                 }
 302                         } finally {
 303                                 if (globalProperties != null) {
 304                                         GlobalProperties = engine_old_grp;
 305                                         project.GlobalProperties = project_old_grp;
 306                                 }
 307                         }
 308                 }
 309
 310                 void CheckBinPath ()
 311                 {
 312                         if (BinPath == null) {
 313                                 throw new InvalidOperationException ("Before a project can be instantiated, " +
 314                                         "Engine.BinPath must be set to the location on disk where MSBuild " +
 315                                         "is installed. This is used to evaluate $(MSBuildBinPath).");
 316                         }
 317                 }
 318
 319                 public Project CreateNewProject ()
 320                 {
 321                         return new Project (this);
 322                 }
 323
 324                 public Project GetLoadedProject (string projectFullFileName)
 325                 {
 326                         if (projectFullFileName == null)
 327                                 throw new ArgumentNullException ("projectFullFileName");
 328
 329                         Project project;
 330                         projects.TryGetValue (projectFullFileName, out project);
 331
 332                         return project;
 333                 }
 334
 335                 internal void RemoveLoadedProject (Project p)
 336                 {
 337                         if (!String.IsNullOrEmpty (p.FullFileName)) {
 338                                 ClearBuiltTargetsForProject (p);
 339                                 projects.Remove (p.FullFileName);
 340                         }
 341                 }
 342
 343                 internal void AddLoadedProject (Project p)
 344                 {
 345                         if (p.FullFileName != String.Empty)
 346                                 projects.Add (p.FullFileName, p);
 347                 }
 348
 349                 public void UnloadProject (Project project)
 350                 {
 351                         if (project == null)
 352                                 throw new ArgumentNullException ("project");
 353
 354                         if (project.ParentEngine != this)
 355                                 throw new InvalidOperationException ("The \"Project\" object specified does not belong to the correct \"Engine\" object.");
 356
 357                         project.CheckUnloaded ();
 358
 359                         RemoveLoadedProject (project);
 360
 361                         project.Unload ();
 362                 }
 363
 364                 public void UnloadAllProjects ()
 365                 {
 366                         IList<Project> values = new List<Project> (projects.Values);
 367                         foreach (Project p in values)
 368                                 UnloadProject (p);
 369                 }
 370
 371                 [MonoTODO]
 372                 public void RegisterLogger (ILogger logger)
 373                 {
 374                         if (logger == null)
 375                                 throw new ArgumentNullException ("logger");
 376
 377                         logger.Initialize (eventSource);
 378                         loggers.Add (logger);
 379                 }
 380
 381                 [MonoTODO]
 382                 public void UnregisterAllLoggers ()
 383                 {
 384                         // FIXME: check if build succeeded
 385                         // FIXME: it shouldn't be here
 386                         if (buildStarted)
 387                                 LogBuildFinished (true);
 388                         foreach (ILogger i in loggers) {
 389                                 i.Shutdown ();
 390                         }
 391                         loggers.Clear ();
 392                 }
 393
 394                 void StartEngineBuild ()
 395                 {
 396                         if (!buildStarted) {
 397                                 LogBuildStarted ();
 398                                 buildStarted = true;
 399                         }
 400                 }
 401
 402                 void EndEngineBuild (bool succeeded)
 403                 {
 404                         if (buildStarted && currentlyBuildingProjectsStack.Count == 0) {
 405                                 LogBuildFinished (succeeded);
 406                                 buildStarted = false;
 407                         }
 408                 }
 409
 410                 internal void StartProjectBuild (Project project, string [] target_names)
 411                 {
 412                         StartEngineBuild ();
 413
 414                         if (currentlyBuildingProjectsStack.Count == 0 ||
 415                                 String.Compare (currentlyBuildingProjectsStack.Peek ().FullFileName, project.FullFileName) != 0)
 416                                         LogProjectStarted (project, target_names);
 417
 418                         currentlyBuildingProjectsStack.Push (project);
 419                 }
 420
 421                 internal void EndProjectBuild (Project project, bool succeeded)
 422                 {
 423                         if (!buildStarted)
 424                                 throw new Exception ("build isnt started currently");
 425
 426                         Project top_project = currentlyBuildingProjectsStack.Pop ();
 427
 428                         if (String.Compare (project.FullFileName, top_project.FullFileName) != 0)
 429                                 throw new Exception (String.Format (
 430                                                         "INTERNAL ERROR: Project finishing is not the same as the one on top " +
 431                                                         "of the stack. Project: {0} Top of stack: {1}",
 432                                                         project.FullFileName, top_project.FullFileName));
 433
 434                         if (currentlyBuildingProjectsStack.Count == 0 ||
 435                                 String.Compare (top_project.FullFileName, currentlyBuildingProjectsStack.Peek ().FullFileName) != 0)
 436                                 LogProjectFinished (top_project, succeeded);
 437
 438                         EndEngineBuild (succeeded);
 439                 }
 440
 441                 internal void ClearBuiltTargetsForProject (Project project)
 442                 {
 443                         string project_key = project.GetKeyForTarget (String.Empty, false);
 444                         var to_remove_keys = BuiltTargetsOutputByName.Keys.Where (key => key.StartsWith (project_key)).ToList ();
 445                         foreach (string to_remove_key in to_remove_keys)
 446                                 BuiltTargetsOutputByName.Remove (to_remove_key);
 447                 }
 448
 449                 void LogProjectStarted (Project project, string [] target_names)
 450                 {
 451                         string targets;
 452                         if (target_names == null || target_names.Length == 0)
 453                                 targets = String.Empty;
 454                         else
 455                                 targets = String.Join (";", target_names);
 456
 457                         ProjectStartedEventArgs psea = new ProjectStartedEventArgs ("Project started.", null, project.FullFileName, targets,
 458                                         project.EvaluatedPropertiesAsDictionaryEntries, project.EvaluatedItemsByNameAsDictionaryEntries);
 459
 460                         eventSource.FireProjectStarted (this, psea);
 461                 }
 462
 463                 void LogProjectFinished (Project project, bool succeeded)
 464                 {
 465                         ProjectFinishedEventArgs pfea;
 466                         pfea = new ProjectFinishedEventArgs ("Project started.", null, project.FullFileName, succeeded);
 467                         eventSource.FireProjectFinished (this, pfea);
 468                 }
 469
 470                 void LogBuildStarted ()
 471                 {
 472                         BuildStartedEventArgs bsea;
 473                         bsea = new BuildStartedEventArgs ("Build started.", null);
 474                         eventSource.FireBuildStarted (this, bsea);
 475                 }
 476
 477                 void LogBuildFinished (bool succeeded)
 478                 {
 479                         BuildFinishedEventArgs bfea;
 480                         bfea = new BuildFinishedEventArgs ("Build finished.", null, succeeded);
 481                         eventSource.FireBuildFinished (this, bfea);
 482                 }
 483
 484                 internal TaskDatabase GetDefaultTasks (string toolsVersion)
 485                 {
 486                         TaskDatabase db;
 487                         if (defaultTasksTableByToolsVersion.TryGetValue (toolsVersion, out db))
 488                                 return db;
 489
 490                         var toolset = Toolsets [toolsVersion];
 491                         if (toolset == null)
 492                                 throw new UnknownToolsVersionException (toolsVersion);
 493
 494                         string toolsPath = toolset.ToolsPath;
 495                         string tasksFile = Path.Combine (toolsPath, defaultTasksProjectName);
 496                         this.LogMessage (MessageImportance.Low, "Loading default tasks for ToolsVersion: {0} from {1}", toolsVersion, tasksFile);
 497
 498                         // set a empty taskdb here, because the project loading the tasks
 499                         // file will try to get the default task db
 500                         defaultTasksTableByToolsVersion [toolsVersion] = new TaskDatabase ();
 501
 502                         db = defaultTasksTableByToolsVersion [toolsVersion] = RegisterDefaultTasks (tasksFile);
 503
 504                         return db;
 505                 }
 506
 507                 TaskDatabase RegisterDefaultTasks (string tasksFile)
 508                 {
 509                         Project defaultTasksProject = CreateNewProject ();
 510                         TaskDatabase db;
 511
 512                         if (File.Exists (tasksFile)) {
 513                                 defaultTasksProject.Load (tasksFile);
 514                                 db = defaultTasksProject.TaskDatabase;
 515                         } else {
 516                                 this.LogWarning ("Default tasks file {0} not found, ignoring.", tasksFile);
 517                                 db = new TaskDatabase ();
 518                         }
 519
 520                         return db;
 521                 }
 522
 523                 public string BinPath {
 524                         get { return binPath; }
 525                         set { binPath = value; }
 526                 }
 527
 528                 public bool BuildEnabled {
 529                         get { return buildEnabled; }
 530                         set { buildEnabled = value; }
 531                 }
 532
 533                 public static Version Version {
 534                         get { return version; }
 535                 }
 536
 537                 public static Engine GlobalEngine {
 538                         get {
 539                                 if (globalEngine == null)
 540                                         globalEngine = new Engine ();
 541                                 return globalEngine;
 542                         }
 543                 }
 544
 545                 public BuildPropertyGroup GlobalProperties {
 546                         get { return global_properties; }
 547                         set { global_properties = value; }
 548                 }
 549
 550                 public ToolsetCollection Toolsets {
 551                         get; private set;
 552                 }
 553
 554                 public string DefaultToolsVersion {
 555                         get {
 556                                 // This is used as the fall back version if the
 557                                 // project can't find a version to use
 558                                 // Hard-coded to 2.0, so it allows even vs2005 projects
 559                                 // to build correctly, as they won't have a ToolsVersion
 560                                 // set!
 561                                 return String.IsNullOrEmpty (defaultToolsVersion)
 562                                                 ? "2.0"
 563                                                 : defaultToolsVersion;
 564                         }
 565                         set {
 566                                 if (Toolsets [value] == null)
 567                                         throw new UnknownToolsVersionException (value);
 568                                 defaultToolsVersion = value;
 569                         }
 570                 }
 571
 572                 public bool IsBuilding {
 573                         get { return buildStarted; }
 574                 }
 575
 576                 public bool OnlyLogCriticalEvents {
 577                         get { return eventSource.OnlyLogCriticalEvents; }
 578                         set { eventSource.OnlyLogCriticalEvents = value; }
 579                 }
 580
 581                 internal EventSource EventSource {
 582                         get { return eventSource; }
 583                 }
 584
 585                 internal Dictionary<string, ITaskItem[]> BuiltTargetsOutputByName {
 586                         get { return builtTargetsOutputByName; }
 587                 }
 588         }
 589 }