2 // ExpressionCollection.cs
5 // Marek Sieradzki (marek.sieradzki@gmail.com)
6 // Ankit Jain (jankit@novell.com)
8 // (C) 2006 Marek Sieradzki
9 // Copyright 2009 Novell, Inc (http://www.novell.com)
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:
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
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.
31 using System.Collections;
32 using System.Collections.Generic;
34 using Microsoft.Build.Framework;
35 using Microsoft.Build.Utilities;
37 namespace Microsoft.Build.BuildEngine {
39 internal class ExpressionCollection {
42 static Dictionary<string, bool> boolValues;
44 static ExpressionCollection ()
46 string[] trueValuesArray = new string[] {"true", "on", "yes"};
47 string[] falseValuesArray = new string[] {"false", "off", "no"};
49 boolValues = new Dictionary<string, bool> (StringComparer.OrdinalIgnoreCase);
50 foreach (string s in trueValuesArray)
51 boolValues.Add (s, true);
52 foreach (string s in falseValuesArray)
53 boolValues.Add (s, false);
56 public ExpressionCollection ()
58 objects = new ArrayList ();
62 get { return objects.Count; }
65 public void Add (IReference reference)
67 objects.Add (reference);
70 public void Add (string s)
75 public object ConvertTo (Project project, Type type, ExpressionOptions options)
78 if (type == typeof (ITaskItem[]))
79 return ConvertToITaskItemArray (project, options);
81 return ConvertToArray (project, type, options);
83 if (type == typeof (ITaskItem))
84 return ConvertToITaskItem (project, options);
86 return ConvertToNonArray (project, type, options);
90 public IEnumerator GetEnumerator ()
92 foreach (object o in objects)
96 object ConvertToNonArray (Project project, Type type, ExpressionOptions options)
98 return ConvertToObject (ConvertToString (project, options), type, options);
101 object ConvertToArray (Project project, Type type, ExpressionOptions options)
103 ITaskItem[] items = ConvertToITaskItemArray (project, options);
105 Type element_type = type.GetElementType ();
106 Array arr = Array.CreateInstance (element_type, items.Length);
107 for (int i = 0; i < arr.Length; i ++)
108 arr.SetValue (ConvertToObject (items [i].ItemSpec, element_type, options), i);
112 object ConvertToObject (string raw, Type type, ExpressionOptions options)
114 if (type == typeof (bool)) {
116 if (boolValues.TryGetValue (raw, out value))
122 if (type == typeof (string))
125 if (type.IsPrimitive)
126 return Convert.ChangeType (raw, type);
128 if (type == typeof (DateTime))
129 return DateTime.Parse (raw);
131 throw new Exception (String.Format ("Unsupported type: {0}", type));
134 string ConvertToString (Project project, ExpressionOptions options)
136 StringBuilder sb = new StringBuilder ();
138 foreach (object o in objects) {
139 string s = o as string;
145 IReference br = o as IReference;
147 sb.Append (br.ConvertToString (project, options));
149 throw new Exception ("BUG: Invalid type in objects collection.");
151 return sb.ToString ();
154 ITaskItem ConvertToITaskItem (Project project, ExpressionOptions options)
157 throw new Exception ("Cannot cast empty expression to ITaskItem.");
159 ITaskItem[] items = ConvertToITaskItemArray (project, options);
160 if (items.Length > 1)
161 //FIXME: msbuild gives better errors
162 throw new Exception (String.Format ("Exactly one item required, but got: {0}", items.Length));
164 if (items.Length == 0) return null;
168 // Concat rules (deduced)
169 // - ItemRef can concat only with a string ';' or PropertyRef ending in ';'
170 // - MetadataRef can concat with anything other than ItemRef
171 // - PropertyRef cannot be right after a ItemRef
172 // PropertyRef concats if it doesn't end in ';'
173 // - string cannot concat with ItemRef unless it is ';'.
174 // string concats if it ends in ';'
175 ITaskItem[] ConvertToITaskItemArray (Project project, ExpressionOptions options)
177 List <ITaskItem> finalItems = new List <ITaskItem> ();
180 bool prev_can_concat = false;
182 foreach (object o in objects) {
183 bool can_concat = prev_can_concat;
185 string str = o as string;
187 string trimmed_str = str.Trim ();
188 if (!IsSemicolon (str) && trimmed_str.Length > 0 && prev != null && prev is ItemReference)
189 // non-empty, non-semicolon string after item ref
190 ThrowCantConcatError (prev, str);
192 if (trimmed_str.Length == 0 && prev is string && IsSemicolon ((string) prev)) {
193 // empty string after a ';', ignore it
197 // empty string _after_ a itemref, not an error
198 prev_can_concat = !(str.Length > 0 && str [str.Length - 1] == ';') && trimmed_str.Length > 0;
199 AddItemsToArray (finalItems,
200 ConvertToITaskItemArrayFromString (str),
206 IReference br = o as IReference;
208 throw new Exception ("BUG: Invalid type in objects collection.");
210 if (o is ItemReference) {
211 if (prev != null && !(prev is string && (string)prev == ";"))
212 ThrowCantConcatError (prev, br);
214 prev_can_concat = true;
215 } else if (o is MetadataReference) {
216 if (prev != null && prev is ItemReference)
217 ThrowCantConcatError (prev, br);
219 prev_can_concat = true;
220 } else if (o is PropertyReference) {
221 if (prev != null && prev is ItemReference)
222 ThrowCantConcatError (prev, br);
224 string value = ((PropertyReference) o).GetValue (project);
225 prev_can_concat = !(value.Length > 0 && value [value.Length - 1] == ';');
228 AddItemsToArray (finalItems, br.ConvertToITaskItemArray (project, options), can_concat);
233 // Trim and Remove empty items
234 List<ITaskItem> toRemove = new List<ITaskItem> ();
235 for (int i = 0; i < finalItems.Count; i ++) {
236 string s = finalItems [i].ItemSpec.Trim ();
238 toRemove.Add (finalItems [i]);
240 finalItems [i].ItemSpec = s;
242 foreach (ITaskItem ti in toRemove)
243 finalItems.Remove (ti);
245 return finalItems.ToArray ();
248 // concat's first item in @items to last item in @list if @concat is true
249 // else just adds all @items to @list
250 void AddItemsToArray (List<ITaskItem> list, ITaskItem[] items, bool concat)
252 if (items == null || items.Length == 0)
256 if (concat && list.Count > 0)
257 list [list.Count - 1].ItemSpec += items [0].ItemSpec;
261 for (int i = start_index; i < items.Length; i ++)
262 list.Add (items [i]);
265 ITaskItem [] ConvertToITaskItemArrayFromString (string source)
267 List <ITaskItem> items = new List <ITaskItem> ();
268 string [] splitSource = source.Split (new char [] {';'},
269 StringSplitOptions.RemoveEmptyEntries);
271 foreach (string s in splitSource)
272 items.Add (new TaskItem (s));
274 return items.ToArray ();
277 bool IsSemicolon (string str)
279 return str != null && str.Length == 1 && str [0] == ';';
282 void ThrowCantConcatError (object first, object second)
284 throw new Exception (String.Format (
285 "Can't concatenate Item list with other strings where an item list is " +
286 "expected ('{0}', '{1}'). Use semi colon to separate items.",
287 first.ToString (), second.ToString ()));