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

   1 //
   2 // BuildEngine.cs: Class that can be accessed by task.
   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 Microsoft.Build.Framework;
  31
  32 namespace Microsoft.Build.BuildEngine {
  33         internal class BuildEngine : IBuildEngine2 {
  34
  35                 Engine  engine;
  36                 int     columnNumberOfTaskNode;
  37                 bool    continueOnError;
  38                 int     lineNumberOfTaskNode;
  39                 Project project;
  40                 string taskfile;
  41
  42                 public BuildEngine (Engine engine, Project project, string taskfile, int column, int line,
  43                                     bool continueOnError)
  44                 {
  45                         this.engine = engine;
  46                         this.project = project;
  47                         this.columnNumberOfTaskNode = column;
  48                         this.continueOnError = continueOnError;
  49                         this.lineNumberOfTaskNode = line;
  50                         this.taskfile = taskfile;
  51                 }
  52
  53                 // Initiates a build of a project file. If the build is
  54                 // successful, the outputs (if any) of the specified targets
  55                 // are returned.
  56                 public bool BuildProjectFile (string projectFileName,
  57                                        string[] targetNames,
  58                                        IDictionary globalProperties,
  59                                        IDictionary targetOutputs)
  60                 {
  61                         return BuildProjectFile (projectFileName, targetNames, globalProperties, targetOutputs, null);
  62                 }
  63
  64                 public bool BuildProjectFile (string projectFileName,
  65                                        string[] targetNames,
  66                                        IDictionary globalProperties,
  67                                        IDictionary targetOutputs, string toolsVersion)
  68                 {
  69                         if (String.IsNullOrEmpty (projectFileName)) {
  70                                 string oldProjectToolsVersion = project.ToolsVersion;
  71                                 project.ToolsVersion = toolsVersion;
  72                                 try {
  73                                         return engine.BuildProject (project, targetNames, targetOutputs,
  74                                                 BuildSettings.DoNotResetPreviouslyBuiltTargets);
  75                                 } finally {
  76                                         project.ToolsVersion = oldProjectToolsVersion;
  77                                 }
  78                         } else {
  79                                 BuildPropertyGroup bpg = new BuildPropertyGroup ();
  80                                 if (globalProperties != null)
  81                                         foreach (DictionaryEntry de in globalProperties)
  82                                                 bpg.AddProperty (new BuildProperty (
  83                                                         (string) de.Key, (string) de.Value,
  84                                                         PropertyType.Global));
  85                                 return engine.BuildProjectFile (projectFileName,
  86                                         targetNames, bpg, targetOutputs, BuildSettings.DoNotResetPreviouslyBuiltTargets, toolsVersion);
  87                         }
  88                 }
  89
  90                 public bool BuildProjectFilesInParallel (string[] projectFileNames,
  91                                         string [] targetNames,
  92                                         IDictionary[] globalProperties,
  93                                         IDictionary[] targetOutputsPerProject,
  94                                         string[] toolsVersion,
  95                                         bool useResultsCache,
  96                                         bool unloadProjectsOnCompletion)
  97                 {
  98                         throw new NotImplementedException ();
  99                 }
 100
 101                 // Raises a custom event to all registered loggers.
 102                 public void LogCustomEvent (CustomBuildEventArgs e)
 103                 {
 104                         engine.EventSource.FireCustomEventRaised (this, e);
 105                 }
 106
 107                 // Raises an error to all registered loggers.
 108                 public void LogErrorEvent (BuildErrorEventArgs e)
 109                 {
 110                         if (ContinueOnError) {
 111                                 // log the error as a warning
 112                                 LogWarningEvent (new BuildWarningEventArgs (
 113                                         e.Subcategory, e.Code, e.File, e.LineNumber, e.ColumnNumber,
 114                                         e.EndLineNumber, e.EndColumnNumber, e.Message,
 115                                         e.HelpKeyword, e.SenderName));
 116
 117                                 LogMessageEvent (new BuildMessageEventArgs (
 118                                                         "Previous error was converted to a warning as the " +
 119                                                         "task was called with ContinueOnError=true.",
 120                                                         null, null, MessageImportance.Normal));
 121
 122                         } else {
 123                                 engine.EventSource.FireErrorRaised (this, e);
 124                         }
 125                 }
 126
 127                 // Raises a message event to all registered loggers.
 128                 public void LogMessageEvent (BuildMessageEventArgs e)
 129                 {
 130                         engine.EventSource.FireMessageRaised (this, e);
 131                 }
 132
 133                 // Raises a warning to all registered loggers.
 134                 public void LogWarningEvent (BuildWarningEventArgs e)
 135                 {
 136                         engine.EventSource.FireWarningRaised (this, e);
 137                 }
 138
 139                 public int ColumnNumberOfTaskNode {
 140                         get { return columnNumberOfTaskNode; }
 141                 }
 142
 143                 public bool ContinueOnError {
 144                         get { return continueOnError; }
 145                 }
 146
 147                 public int LineNumberOfTaskNode {
 148                         get { return lineNumberOfTaskNode; }
 149                 }
 150
 151                 public string ProjectFileOfTaskNode {
 152                         get { return taskfile; }
 153                 }
 154
 155                 public bool IsRunningMultipleNodes {
 156                         get { return false; }
 157                 }
 158
 159         }
 160 }