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                 ImportedProject         importedProject;
  43                 XmlElement              itemGroupElement;
  44                 GroupingCollection      parentCollection;
  45                 Project                 parentProject;
  46                 bool                    read_only;
  47
  48                 public BuildItemGroup ()
  49                         : this (null, null, null, false)
  50                 {
  51                 }
  52
  53                 internal BuildItemGroup (XmlElement xmlElement, Project project, ImportedProject importedProject, bool readOnly)
  54                 {
  55                         this.buildItems = new List <BuildItem> ();
  56                         this.importedProject = importedProject;
  57                         this.itemGroupElement = xmlElement;
  58                         this.parentProject = project;
  59                         this.read_only = readOnly;
  60
  61                         if (!FromXml)
  62                                 return;
  63
  64                         foreach (XmlNode xn in xmlElement.ChildNodes) {
  65                                 if (!(xn is XmlElement))
  66                                         continue;
  67
  68                                 XmlElement xe = (XmlElement) xn;
  69                                 BuildItem bi = new BuildItem (xe, this);
  70                                 buildItems.Add (bi);
  71                         }
  72                 }
  73
  74                 public BuildItem AddNewItem (string itemName,
  75                                              string itemInclude)
  76                 {
  77                         return AddNewItem (itemName, itemInclude, false);
  78                 }
  79
  80                 [MonoTODO]
  81                 public BuildItem AddNewItem (string itemName,
  82                                              string itemInclude,
  83                                              bool treatItemIncludeAsLiteral)
  84                 {
  85                         if (treatItemIncludeAsLiteral)
  86                                 itemInclude = Utilities.Escape (itemInclude);
  87
  88                         BuildItem bi = new BuildItem (itemName, itemInclude);
  89
  90                         bi.Evaluate (null, true);
  91
  92                         if (!read_only)
  93                                 buildItems.Add (bi);
  94
  95                         return bi;
  96                 }
  97
  98                 public void Clear ()
  99                 {
 100                         if (FromXml)
 101                                 itemGroupElement.RemoveAll ();
 102
 103                         buildItems = new List <BuildItem> ();
 104                 }
 105
 106                 [MonoTODO]
 107                 public BuildItemGroup Clone (bool deepClone)
 108                 {
 109                         if (deepClone) {
 110                                 if (FromXml)
 111                                         throw new NotImplementedException ();
 112                                 else
 113                                         throw new NotImplementedException ();
 114                         } else {
 115                                 if (FromXml)
 116                                         throw new InvalidOperationException ("A shallow clone of this object cannot be created.");
 117                                 else
 118                                         throw new NotImplementedException ();
 119                         }
 120                 }
 121
 122                 public IEnumerator GetEnumerator ()
 123                 {
 124                         return buildItems.GetEnumerator ();
 125                 }
 126
 127                 public void RemoveItem (BuildItem itemToRemove)
 128                 {
 129                         buildItems.Remove (itemToRemove);
 130                 }
 131
 132                 public void RemoveItemAt (int index)
 133                 {
 134                         buildItems.RemoveAt (index);
 135                 }
 136
 137                 public BuildItem[] ToArray ()
 138                 {
 139                         return buildItems.ToArray ();
 140                 }
 141
 142                 internal void AddItem (BuildItem buildItem)
 143                 {
 144                         buildItems.Add (buildItem);
 145                 }
 146
 147                 internal void AddItem (string name, ITaskItem taskItem)
 148                 {
 149                         BuildItem buildItem;
 150                         buildItem = new BuildItem (name, taskItem);
 151                         buildItems.Add (buildItem);
 152                 }
 153
 154                 internal string ConvertToString (Expression transform,
 155                                                  Expression separator)
 156                 {
 157                         string separatorString;
 158
 159                         if (separator == null)
 160                                 separatorString = ";";
 161                         else
 162                                 separatorString = (string) separator.ConvertTo (parentProject, typeof (string));
 163
 164                         string[] items = new string [buildItems.Count];
 165                         int i = 0;
 166                         foreach (BuildItem bi in  buildItems)
 167                                 items [i++] = bi.ConvertToString (transform);
 168                         return String.Join (separatorString, items);
 169                 }
 170
 171                 internal ITaskItem[] ConvertToITaskItemArray (Expression transform)
 172                 {
 173                         ITaskItem[] array = new ITaskItem [buildItems.Count];
 174                         int i = 0;
 175                         foreach (BuildItem item in buildItems)
 176                                 array [i++] = item.ConvertToITaskItem (transform);
 177                         return array;
 178                 }
 179
 180                 internal void Evaluate ()
 181                 {
 182                         foreach (BuildItem bi in buildItems) {
 183                                 if (bi.Condition == String.Empty)
 184                                         bi.Evaluate (parentProject, true);
 185                                 else {
 186                                         ConditionExpression ce = ConditionParser.ParseCondition (bi.Condition);
 187                                         bi.Evaluate (parentProject, ce.BoolEvaluate (parentProject));
 188                                 }
 189                         }
 190                 }
 191
 192                 internal void ReplaceWith (BuildItem item, List <BuildItem> list)
 193                 {
 194                         int index = buildItems.IndexOf (item);
 195                         buildItems.RemoveAt (index);
 196                         buildItems.InsertRange (index, list);
 197                 }
 198
 199                 [MonoTODO]
 200                 // FIXME: whether we can invoke get_Condition on BuildItemGroup not based on XML
 201                 public string Condition {
 202                         get {
 203                                 if (FromXml)
 204                                         return itemGroupElement.GetAttribute ("Condition");
 205                                 else
 206                                         return String.Empty;
 207                         }
 208                         set {
 209                                 if (FromXml)
 210                                         itemGroupElement.SetAttribute ("Condition", value);
 211                                 else
 212                                         throw new InvalidOperationException ("Cannot set a condition on an object not represented by an XML element in the project file.");
 213                         }
 214                 }
 215
 216                 public int Count {
 217                         get { return buildItems.Count; }
 218                 }
 219
 220                 public bool IsImported {
 221                         get { return importedProject != null; }
 222                 }
 223
 224
 225                 [MonoTODO]
 226                 public BuildItem this [int index] {
 227                         get {
 228                                 return buildItems [index];
 229                         }
 230                 }
 231
 232                 internal GroupingCollection GroupingCollection {
 233                         get { return parentCollection; }
 234                         set { parentCollection = value; }
 235                 }
 236
 237                 internal Project Project {
 238                         get { return parentProject; }
 239                 }
 240
 241                 internal bool FromXml {
 242                         get {
 243                                 return itemGroupElement != null;
 244                         }
 245                 }
 246
 247                 internal XmlElement XmlElement {
 248                         get {
 249                                 return itemGroupElement;
 250                         }
 251                 }
 252         }
 253 }
 254
 255 #endif