mcs/class/Microsoft.Build.Utilities/Microsoft.Build.Utilities/TaskItem.cs

   1 //
   2 // TaskItem.cs: Represents an item belonging to a task.
   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.Collections;
  32 using System.Collections.Specialized;
  33 using System.IO;
  34 using Microsoft.Build.Framework;
  35 using Mono.XBuild.Utilities;
  36
  37 namespace Microsoft.Build.Utilities
  38 {
  39 #if !MICROSOFT_BUILD_DLL
  40         public
  41 #endif
  42         sealed class TaskItem : MarshalByRefObject, ITaskItem
  43         {
  44                 IDictionary             metadata;
  45                 string                  itemSpec;
  46
  47                 public TaskItem ()
  48                 {
  49                         this.itemSpec = String.Empty;
  50                         this.metadata = CollectionsUtil.CreateCaseInsensitiveHashtable ();
  51                 }
  52
  53                 public TaskItem (ITaskItem sourceItem)
  54                 {
  55                         if (sourceItem == null)
  56                                 throw new ArgumentNullException ("sourceItem");
  57
  58                         this.itemSpec = sourceItem.ItemSpec;
  59                         this.metadata = sourceItem.CloneCustomMetadata ();
  60                 }
  61
  62                 public TaskItem (string itemSpec)
  63                 {
  64                         if (itemSpec == null)
  65                                 throw new ArgumentNullException ("itemSpec");
  66
  67                         this.itemSpec = itemSpec;
  68                         this.metadata = CollectionsUtil.CreateCaseInsensitiveHashtable ();
  69
  70                         // FIXME: hack
  71                         this.itemSpec = itemSpec.Replace ('\\', Path.DirectorySeparatorChar);
  72                 }
  73
  74                 public TaskItem (string itemSpec, IDictionary itemMetadata)
  75                 {
  76                         if (itemSpec == null)
  77                                 throw new ArgumentNullException ("itemSpec");
  78
  79                         if (itemMetadata == null)
  80                                 throw new ArgumentNullException ("itemMetadata");
  81
  82                         this.itemSpec = itemSpec;
  83                         this.metadata = CollectionsUtil.CreateCaseInsensitiveHashtable (itemMetadata);
  84                 }
  85
  86                 public IDictionary CloneCustomMetadata ()
  87                 {
  88                         IDictionary clonedMetadata = CollectionsUtil.CreateCaseInsensitiveHashtable ();
  89                         foreach (DictionaryEntry de in metadata)
  90                                 clonedMetadata.Add (de.Key, de.Value);
  91                         return clonedMetadata;
  92                 }
  93
  94                 public void CopyMetadataTo (ITaskItem destinationItem)
  95                 {
  96                         foreach (DictionaryEntry e in metadata) {
  97                                 if (destinationItem.GetMetadata ((string)e.Key) == String.Empty) {
  98                                         destinationItem.SetMetadata ((string)e.Key, (string)e.Value);
  99                                 }
 100                         }
 101                 }
 102
 103                 public static explicit operator string (TaskItem taskItemToCast)
 104                 {
 105                         return taskItemToCast.ItemSpec;
 106                 }
 107
 108                 public string GetMetadata (string metadataName)
 109                 {
 110                         if (ReservedNameUtils.IsReservedMetadataName (metadataName))
 111                                 return ReservedNameUtils.GetReservedMetadata (ItemSpec, metadataName, metadata);
 112                         else if (metadata.Contains (metadataName))
 113                                 return (string) metadata [metadataName];
 114                         else
 115                                 return String.Empty;
 116                 }
 117
 118                 public override object InitializeLifetimeService ()
 119                 {
 120                         return null;
 121                 }
 122
 123                 public void RemoveMetadata (string metadataName)
 124                 {
 125                         if (metadataName == null)
 126                                 throw new ArgumentNullException ("metadataName");
 127                         if (ReservedNameUtils.IsReservedMetadataName (metadataName))
 128                                 throw new ArgumentException ("Can't remove reserved metadata");
 129                         if (metadata.Contains (metadataName))
 130                                 metadata.Remove (metadataName);
 131                 }
 132
 133                 public void SetMetadata (string metadataName, string metadataValue)
 134                 {
 135                         if (metadataName == null)
 136                                 throw new ArgumentNullException ("metadataName");
 137                         if (metadataValue == null)
 138                                 throw new ArgumentNullException ("metadataValue");
 139
 140                         // allow RecursiveDir to be set, it gets set by DirectoryScanner
 141                         if (String.Compare (metadataName, "RecursiveDir", StringComparison.InvariantCultureIgnoreCase) != 0 &&
 142                                 ReservedNameUtils.IsReservedMetadataName (metadataName))
 143                                 throw new ArgumentException ("Can't modify reserved metadata");
 144
 145                         if (metadata.Contains (metadataName))
 146                                 metadata.Remove (metadataName);
 147                         metadata.Add (metadataName, metadataValue);
 148                 }
 149
 150                 public override string ToString ()
 151                 {
 152                         return itemSpec;
 153                 }
 154
 155                 public string ItemSpec {
 156                         get { return itemSpec; }
 157                         set { itemSpec = value; }
 158                 }
 159
 160                 public int MetadataCount {
 161                         get { return metadata.Count + 11; }
 162                 }
 163
 164                 public ICollection MetadataNames {
 165                         get {
 166                                 ArrayList list = new ArrayList ();
 167
 168                                 foreach (string s in ReservedNameUtils.ReservedMetadataNames)
 169                                         list.Add (s);
 170                                 foreach (string s in metadata.Keys)
 171                                         list.Add (s);
 172
 173                                 return list;
 174                         }
 175                 }
 176         }
 177 }
 178
 179 #endif