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