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

   1 //
   2 // ExpressionCollection.cs
   3 //
   4 // Author:
   5 //   Marek Sieradzki (marek.sieradzki@gmail.com)
   6 //   Ankit Jain (jankit@novell.com)
   7 //
   8 // (C) 2006 Marek Sieradzki
   9 // Copyright 2009 Novell, Inc (http://www.novell.com)
  10 //
  11 // Permission is hereby granted, free of charge, to any person obtaining
  12 // a copy of this software and associated documentation files (the
  13 // "Software"), to deal in the Software without restriction, including
  14 // without limitation the rights to use, copy, modify, merge, publish,
  15 // distribute, sublicense, and/or sell copies of the Software, and to
  16 // permit persons to whom the Software is furnished to do so, subject to
  17 // the following conditions:
  18 //
  19 // The above copyright notice and this permission notice shall be
  20 // included in all copies or substantial portions of the Software.
  21 //
  22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29
  30 #if NET_2_0
  31
  32 using System;
  33 using System.Collections;
  34 using System.Collections.Generic;
  35 using System.Text;
  36 using Microsoft.Build.Framework;
  37 using Microsoft.Build.Utilities;
  38
  39 namespace Microsoft.Build.BuildEngine {
  40
  41         internal class ExpressionCollection {
  42
  43                 IList objects;
  44                 static Dictionary<string, bool> boolValues;
  45
  46                 static ExpressionCollection ()
  47                 {
  48                         string[] trueValuesArray = new string[] {"true", "on", "yes"};
  49                         string[] falseValuesArray = new string[] {"false", "off", "no"};
  50
  51                         boolValues = new Dictionary<string, bool> (StringComparer.OrdinalIgnoreCase);
  52                         foreach (string s in trueValuesArray)
  53                                 boolValues.Add (s, true);
  54                         foreach (string s in falseValuesArray)
  55                                 boolValues.Add (s, false);
  56                 }
  57
  58                 public ExpressionCollection ()
  59                 {
  60                         objects = new ArrayList ();
  61                 }
  62
  63                 public int Count {
  64                         get { return objects.Count; }
  65                 }
  66
  67                 public void Add (IReference reference)
  68                 {
  69                         objects.Add (reference);
  70                 }
  71
  72                 public void Add (string s)
  73                 {
  74                         objects.Add (s);
  75                 }
  76
  77                 public object ConvertTo (Project project, Type type, ExpressionOptions options)
  78                 {
  79                         if (type.IsArray) {
  80                                 if (type == typeof (ITaskItem[]))
  81                                         return ConvertToITaskItemArray (project, options);
  82                                 else
  83                                         return ConvertToArray (project, type, options);
  84                         } else {
  85                                 if (type == typeof (ITaskItem))
  86                                         return ConvertToITaskItem (project, options);
  87                                 else
  88                                         return ConvertToNonArray (project, type, options);
  89                         }
  90                 }
  91
  92                 public IEnumerator GetEnumerator ()
  93                 {
  94                         foreach (object o in objects)
  95                                 yield return o;
  96                 }
  97
  98                 object ConvertToNonArray (Project project, Type type, ExpressionOptions options)
  99                 {
 100                         return ConvertToObject (ConvertToString (project, options), type, options);
 101                 }
 102
 103                 object ConvertToArray (Project project, Type type, ExpressionOptions options)
 104                 {
 105                         ITaskItem[] items = ConvertToITaskItemArray (project, options);
 106
 107                         Type element_type = type.GetElementType ();
 108                         Array arr = Array.CreateInstance (element_type, items.Length);
 109                         for (int i = 0; i < arr.Length; i ++)
 110                                 arr.SetValue (ConvertToObject (items [i].ItemSpec, element_type, options), i);
 111                         return arr;
 112                 }
 113
 114                 object ConvertToObject (string raw, Type type, ExpressionOptions options)
 115                 {
 116                         if (type == typeof (bool)) {
 117                                 bool value;
 118                                 if (boolValues.TryGetValue (raw, out value))
 119                                         return value;
 120                                 else
 121                                         return false;
 122                         }
 123
 124                         if (type == typeof (string))
 125                                 return raw;
 126
 127                         if (type.IsPrimitive)
 128                                 return Convert.ChangeType (raw, type);
 129
 130                         if (type == typeof (DateTime))
 131                                 return DateTime.Parse (raw);
 132
 133                         throw new Exception (String.Format ("Unsupported type: {0}", type));
 134                 }
 135
 136                 string ConvertToString (Project project, ExpressionOptions options)
 137                 {
 138                         StringBuilder sb = new StringBuilder ();
 139
 140                         foreach (object o in objects) {
 141                                 string s = o as string;
 142                                 if (s != null) {
 143                                         sb.Append (s);
 144                                         continue;
 145                                 }
 146
 147                                 IReference br = o as IReference;
 148                                 if (br != null)
 149                                         sb.Append (br.ConvertToString (project, options));
 150                                 else
 151                                         throw new Exception ("BUG: Invalid type in objects collection.");
 152                         }
 153                         return sb.ToString ();
 154                 }
 155
 156                 ITaskItem ConvertToITaskItem (Project project, ExpressionOptions options)
 157                 {
 158                         if (objects == null)
 159                                 throw new Exception ("Cannot cast empty expression to ITaskItem.");
 160
 161                         ITaskItem[] items = ConvertToITaskItemArray (project, options);
 162                         if (items.Length > 1)
 163                                 //FIXME: msbuild gives better errors
 164                                 throw new Exception (String.Format ("Exactly one item required, but got: {0}", items.Length));
 165
 166                         if (items.Length == 0) return null;
 167                         return items [0];
 168                 }
 169
 170                 // Concat rules (deduced)
 171                 // - ItemRef can concat only with a string ';' or PropertyRef ending in ';'
 172                 // - MetadataRef can concat with anything other than ItemRef
 173                 // - PropertyRef cannot be right after a ItemRef
 174                 //   PropertyRef concats if it doesn't end in ';'
 175                 // - string cannot concat with ItemRef unless it is ';'.
 176                 //   string concats if it ends in ';'
 177                 ITaskItem[] ConvertToITaskItemArray (Project project, ExpressionOptions options)
 178                 {
 179                         List <ITaskItem> finalItems = new List <ITaskItem> ();
 180
 181                         object prev = null;
 182                         bool prev_can_concat = false;
 183
 184                         foreach (object o in objects) {
 185                                 bool can_concat = prev_can_concat;
 186
 187                                 string str = o as string;
 188                                 if (str != null) {
 189                                         string trimmed_str = str.Trim ();
 190                                         if (!IsSemicolon (str) && trimmed_str.Length > 0 && prev != null && prev is ItemReference)
 191                                                 // non-empty, non-semicolon string after item ref
 192                                                 ThrowCantConcatError (prev, str);
 193
 194                                         if (trimmed_str.Length == 0 && prev is string && IsSemicolon ((string) prev)) {
 195                                                 // empty string after a ';', ignore it
 196                                                 continue;
 197                                         }
 198
 199                                         // empty string _after_ a itemref, not an error
 200                                         prev_can_concat = !(str.Length > 0 && str [str.Length - 1] == ';') && trimmed_str.Length > 0;
 201                                         AddItemsToArray (finalItems,
 202                                                         ConvertToITaskItemArrayFromString (str),
 203                                                         can_concat);
 204                                         prev = o;
 205                                         continue;
 206                                 }
 207
 208                                 IReference br = o as IReference;
 209                                 if (br == null)
 210                                         throw new Exception ("BUG: Invalid type in objects collection.");
 211
 212                                 if (o is ItemReference) {
 213                                         if (prev != null && !(prev is string && (string)prev == ";"))
 214                                                 ThrowCantConcatError (prev, br);
 215
 216                                         prev_can_concat = true;
 217                                 } else if (o is MetadataReference) {
 218                                         if (prev != null && prev is ItemReference)
 219                                                 ThrowCantConcatError (prev, br);
 220
 221                                         prev_can_concat = true;
 222                                 } else if (o is PropertyReference) {
 223                                         if (prev != null && prev is ItemReference)
 224                                                 ThrowCantConcatError (prev, br);
 225
 226                                         string value = ((PropertyReference) o).GetValue (project);
 227                                         prev_can_concat = !(value.Length > 0 && value [value.Length - 1] == ';');
 228                                 }
 229
 230                                 AddItemsToArray (finalItems, br.ConvertToITaskItemArray (project, options), can_concat);
 231
 232                                 prev = o;
 233                         }
 234
 235                         // Trim and Remove empty items
 236                         List<ITaskItem> toRemove = new List<ITaskItem> ();
 237                         for (int i = 0; i < finalItems.Count; i ++) {
 238                                 string s = finalItems [i].ItemSpec.Trim ();
 239                                 if (s.Length == 0)
 240                                         toRemove.Add (finalItems [i]);
 241                                 else
 242                                         finalItems [i].ItemSpec = s;
 243                         }
 244                         foreach (ITaskItem ti in toRemove)
 245                                 finalItems.Remove (ti);
 246
 247                         return finalItems.ToArray ();
 248                 }
 249
 250                 // concat's first item in @items to last item in @list if @concat is true
 251                 // else just adds all @items to @list
 252                 void AddItemsToArray (List<ITaskItem> list, ITaskItem[] items, bool concat)
 253                 {
 254                         if (items == null || items.Length == 0)
 255                                 return;
 256
 257                         int start_index = 1;
 258                         if (concat && list.Count > 0)
 259                                 list [list.Count - 1].ItemSpec += items [0].ItemSpec;
 260                         else
 261                                 start_index = 0;
 262
 263                         for (int i = start_index; i < items.Length; i ++)
 264                                 list.Add (items [i]);
 265                 }
 266
 267                 ITaskItem [] ConvertToITaskItemArrayFromString (string source)
 268                 {
 269                         List <ITaskItem> items = new List <ITaskItem> ();
 270                         string [] splitSource = source.Split (new char [] {';'},
 271                                         StringSplitOptions.RemoveEmptyEntries);
 272
 273                         foreach (string s in splitSource)
 274                                 items.Add (new TaskItem (s));
 275
 276                         return items.ToArray ();
 277                 }
 278
 279                 bool IsSemicolon (string str)
 280                 {
 281                         return str != null && str.Length == 1 && str [0] == ';';
 282                 }
 283
 284                 void ThrowCantConcatError (object first, object second)
 285                 {
 286                         throw new Exception (String.Format (
 287                                         "Can't concatenate Item list with other strings where an item list is " +
 288                                         "expected ('{0}', '{1}'). Use semi colon to separate items.",
 289                                         first.ToString (), second.ToString ()));
 290                 }
 291
 292         }
 293 }
 294
 295 #endif