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

   1 //
   2 // BuildItemGroup.cs: Represents a group of build items.
   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.Reflection;
  32 using System.Collections;
  33 using System.Collections.Generic;
  34 using System.Xml;
  35 using Microsoft.Build.Framework;
  36 using Microsoft.Build.Utilities;
  37
  38 namespace Microsoft.Build.BuildEngine {
  39         public class BuildItemGroup : IEnumerable {
  40
  41                 List <BuildItem>        buildItems;
  42                 GroupingCollection      parentCollection;
  43                 Project                 parentProject;
  44                 ImportedProject         importedProject;
  45                 XmlElement              itemGroupElement;
  46
  47                 public BuildItemGroup ()
  48                         : this (null, null, null)
  49                 {
  50                 }
  51
  52                 internal BuildItemGroup (XmlElement xmlElement, Project project, ImportedProject importedProject)
  53                 {
  54                         this.buildItems = new List <BuildItem> ();
  55                         this.importedProject = importedProject;
  56                         this.itemGroupElement = xmlElement;
  57                         this.parentProject = project;
  58
  59                         if (!FromXml)
  60                                 return;
  61
  62                         foreach (XmlNode xn in xmlElement.ChildNodes) {
  63                                 if (!(xn is XmlElement))
  64                                         continue;
  65
  66                                 XmlElement xe = (XmlElement) xn;
  67                                 BuildItem bi = new BuildItem (xe, this);
  68                                 buildItems.Add (bi);
  69                         }
  70                 }
  71
  72                 public BuildItem AddNewItem (string itemName,
  73                                              string itemInclude)
  74                 {
  75                         return AddNewItem (itemName, itemInclude, false);
  76                 }
  77
  78                 [MonoTODO]
  79                 public BuildItem AddNewItem (string itemName,
  80                                              string itemInclude,
  81                                              bool treatItemIncludeAsLiteral)
  82                 {
  83                         BuildItem bi = new BuildItem (itemName, itemInclude);
  84                         buildItems.Add (bi);
  85                         return bi;
  86                 }
  87
  88                 public void Clear ()
  89                 {
  90                         buildItems = new List <BuildItem> ();
  91                 }
  92
  93                 [MonoTODO]
  94                 public BuildItemGroup Clone (bool deepClone)
  95                 {
  96                         BuildItemGroup big = new BuildItemGroup ();
  97                         // FIXME: add copying of items
  98                         return big;
  99                 }
 100
 101                 public IEnumerator GetEnumerator ()
 102                 {
 103                         return buildItems.GetEnumerator ();
 104                 }
 105
 106                 public void RemoveItem (BuildItem itemToRemove)
 107                 {
 108                         buildItems.Remove (itemToRemove);
 109                 }
 110
 111                 public void RemoveItemAt (int index)
 112                 {
 113                         buildItems.RemoveAt (index);
 114                 }
 115
 116                 public BuildItem[] ToArray ()
 117                 {
 118                         return buildItems.ToArray ();
 119                 }
 120
 121                 internal void AddItem (BuildItem buildItem)
 122                 {
 123                         buildItems.Add (buildItem);
 124                 }
 125
 126                 internal void AddItem (string name, ITaskItem taskItem)
 127                 {
 128                         BuildItem buildItem;
 129                         buildItem = new BuildItem (name, taskItem);
 130                         buildItems.Add (buildItem);
 131                 }
 132
 133                 internal string ConvertToString (Expression transform,
 134                                                  Expression separator)
 135                 {
 136                         string separatorString;
 137
 138                         if (separator == null)
 139                                 separatorString = ";";
 140                         else
 141                                 separatorString = (string) separator.ConvertTo (parentProject, typeof (string));
 142
 143                         string[] items = new string [buildItems.Count];
 144                         int i = 0;
 145                         foreach (BuildItem bi in  buildItems)
 146                                 items [i++] = bi.ConvertToString (transform);
 147                         return String.Join (separatorString, items);
 148                 }
 149
 150                 internal ITaskItem[] ConvertToITaskItemArray (Expression transform)
 151                 {
 152                         ITaskItem[] array = new ITaskItem [buildItems.Count];
 153                         int i = 0;
 154                         foreach (BuildItem item in buildItems)
 155                                 array [i++] = item.ConvertToITaskItem (transform);
 156                         return array;
 157                 }
 158
 159                 internal void Evaluate ()
 160                 {
 161                         foreach (BuildItem bi in buildItems) {
 162                                 if (bi.Condition == String.Empty)
 163                                         bi.Evaluate (true);
 164                                 else {
 165                                         ConditionExpression ce = ConditionParser.ParseCondition (bi.Condition);
 166                                         bi.Evaluate (ce.BoolEvaluate (parentProject));
 167                                 }
 168                         }
 169                 }
 170
 171                 [MonoTODO]
 172                 // FIXME: whether we can invoke get_Condition on BuildItemGroup not based on XML
 173                 public string Condition {
 174                         get {
 175                                 if (FromXml)
 176                                         return itemGroupElement.GetAttribute ("Condition");
 177                                 else
 178                                         return String.Empty;
 179                         }
 180                         set {
 181                                 if (FromXml)
 182                                         itemGroupElement.SetAttribute ("Condition", value);
 183                         }
 184                 }
 185
 186                 public int Count {
 187                         get { return buildItems.Count; }
 188                 }
 189
 190                 public bool IsImported {
 191                         get { return importedProject != null; }
 192                 }
 193
 194
 195                 [MonoTODO]
 196                 public BuildItem this [int index] {
 197                         get {
 198                                 return buildItems [index];
 199                         }
 200                 }
 201
 202                 internal GroupingCollection GroupingCollection {
 203                         get { return parentCollection; }
 204                         set { parentCollection = value; }
 205                 }
 206
 207                 internal Project Project {
 208                         get { return parentProject; }
 209                 }
 210
 211                 internal bool FromXml {
 212                         get {
 213                                 return itemGroupElement != null;
 214                         }
 215                 }
 216         }
 217 }
 218
 219 #endif