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

   1 //
   2 // TaskBatchingImpl.cs: Class that implements Task Batching Algorithm from the wiki.
   3 //
   4 // Author:
   5 //   Marek Sieradzki (marek.sieradzki@gmail.com)
   6 //   Ankit Jain (jankit@novell.com)
   7 //
   8 // (C) 2005 Marek Sieradzki
   9 // Copyright 2008 Novell, Inc (http://www.novell.com)
  10 // Copyright 2009 Novell, Inc (http://www.novell.com)
  11 //
  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:
  19 //
  20 // The above copyright notice and this permission notice shall be
  21 // included in all copies or substantial portions of the Software.
  22 //
  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.
  30
  31 #if NET_2_0
  32
  33 using System;
  34 using System.Collections.Generic;
  35 using System.Xml;
  36
  37 namespace Microsoft.Build.BuildEngine {
  38         internal class TaskBatchingImpl : BatchingImplBase
  39         {
  40                 public TaskBatchingImpl (Project project)
  41                         : base (project)
  42                 {
  43                 }
  44
  45                 public bool Build (BuildTask buildTask, out bool executeOnErrors)
  46                 {
  47                         executeOnErrors = false;
  48                         try {
  49                                 Init ();
  50
  51                                 // populate list of referenced items and metadata
  52                                 ParseTaskAttributes (buildTask);
  53                                 if (consumedMetadataReferences.Count == 0) {
  54                                         // No batching required
  55                                         if (ConditionParser.ParseAndEvaluate (buildTask.Condition, project))
  56                                                 return buildTask.Execute ();
  57                                         else // skipped, it should be logged
  58                                                 return true;
  59                                 }
  60
  61                                 BatchAndPrepareBuckets ();
  62                                 return Run (buildTask, out executeOnErrors);
  63                         } finally {
  64                                 consumedItemsByName = null;
  65                                 consumedMetadataReferences = null;
  66                                 consumedQMetadataReferences = null;
  67                                 consumedUQMetadataReferences = null;
  68                                 batchedItemsByName = null;
  69                                 commonItemsByName = null;
  70                         }
  71                 }
  72
  73                 bool Run (BuildTask buildTask, out bool executeOnErrors)
  74                 {
  75                         executeOnErrors = false;
  76
  77                         // Run the task in batches
  78                         bool retval = true;
  79                         if (buckets.Count == 0) {
  80                                 // batched mode, but no values in the corresponding items!
  81                                 if (ConditionParser.ParseAndEvaluate (buildTask.Condition, project)) {
  82                                         retval = buildTask.Execute ();
  83                                         if (!retval && !buildTask.ContinueOnError)
  84                                                 executeOnErrors = true;
  85                                 }
  86
  87                                 return retval;
  88                         }
  89
  90                         // batched
  91                         foreach (Dictionary<string, BuildItemGroup> bucket in buckets) {
  92                                 project.PushBatch (bucket, commonItemsByName);
  93                                 try {
  94                                         if (ConditionParser.ParseAndEvaluate (buildTask.Condition, project)) {
  95                                                  retval = buildTask.Execute ();
  96                                                  if (!retval && !buildTask.ContinueOnError) {
  97                                                         executeOnErrors = true;
  98                                                         break;
  99                                                  }
 100                                         }
 101                                 } finally {
 102                                         project.PopBatch ();
 103                                 }
 104                         }
 105
 106                         return retval;
 107                 }
 108
 109
 110                 // Parse task attributes to get list of referenced metadata and items
 111                 // to determine batching
 112                 //
 113                 void ParseTaskAttributes (BuildTask buildTask)
 114                 {
 115                         foreach (XmlAttribute attrib in buildTask.TaskElement.Attributes)
 116                                 ParseAttribute (attrib.Value);
 117
 118                         foreach (XmlNode xn in buildTask.TaskElement.ChildNodes) {
 119                                 XmlElement xe = xn as XmlElement;
 120                                 if (xe == null)
 121                                         continue;
 122
 123                                 //FIXME: error on any other child
 124                                 if (String.Compare (xe.LocalName, "Output", StringComparison.Ordinal) == 0) {
 125                                         foreach (XmlAttribute attrib in xe.Attributes)
 126                                                 ParseAttribute (attrib.Value);
 127                                 }
 128                         }
 129                 }
 130         }
 131
 132 }
 133
 134 #endif