mcs/class/System.XML/System.Xml/XmlNamespaceManager.cs

   1 //
   2 // XmlNamespaceManager.cs
   3 //
   4 // Authors:
   5 //   Jason Diamond (jason@injektilo.org)
   6 //   Ben Maurer (bmaurer@users.sourceforge.net)
   7 //   Atsushi Enomoto (atsushi@ximian.com)
   8 //
   9 // (C) 2001 Jason Diamond  http://injektilo.org/
  10 // (C) 2003 Ben Maurer
  11 // (C) 2004 Novell Inc.
  12 //
  13
  14 //
  15 // Permission is hereby granted, free of charge, to any person obtaining
  16 // a copy of this software and associated documentation files (the
  17 // "Software"), to deal in the Software without restriction, including
  18 // without limitation the rights to use, copy, modify, merge, publish,
  19 // distribute, sublicense, and/or sell copies of the Software, and to
  20 // permit persons to whom the Software is furnished to do so, subject to
  21 // the following conditions:
  22 //
  23 // The above copyright notice and this permission notice shall be
  24 // included in all copies or substantial portions of the Software.
  25 //
  26 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  27 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  29 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  30 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  31 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  32 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  33 //
  34
  35 using System.Collections;
  36 #if NET_2_0
  37 using System.Collections.Generic;
  38 #endif
  39 using System.Collections.Specialized;
  40
  41 namespace System.Xml
  42 {
  43         public class XmlNamespaceManager : IXmlNamespaceResolver, IEnumerable
  44         {
  45                 #region Data
  46                 struct NsDecl {
  47                         public string Prefix, Uri;
  48                 }
  49
  50                 struct NsScope {
  51                         public int DeclCount;
  52                         public string DefaultNamespace;
  53                 }
  54
  55                 NsDecl [] decls;
  56                 int declPos = -1;
  57
  58                 NsScope [] scopes;
  59                 int scopePos = -1;
  60
  61                 string defaultNamespace;
  62                 int count;
  63
  64                 void InitData ()
  65                 {
  66                         decls = new NsDecl [10];
  67                         scopes = new NsScope [40];
  68                 }
  69
  70                 // precondition declPos == nsDecl.Length
  71                 void GrowDecls ()
  72                 {
  73                         NsDecl [] old = decls;
  74                         decls = new NsDecl [declPos * 2 + 1];
  75                         if (declPos > 0)
  76                                 Array.Copy (old, 0, decls, 0, declPos);
  77                 }
  78
  79                 // precondition scopePos == scopes.Length
  80                 void GrowScopes ()
  81                 {
  82                         NsScope [] old = scopes;
  83                         scopes = new NsScope [scopePos * 2 + 1];
  84                         if (scopePos > 0)
  85                                 Array.Copy (old, 0, scopes, 0, scopePos);
  86                 }
  87
  88                 #endregion
  89
  90                 #region Fields
  91
  92                 private XmlNameTable nameTable;
  93                 internal const string XmlnsXml = "http://www.w3.org/XML/1998/namespace";
  94                 internal const string XmlnsXmlns = "http://www.w3.org/2000/xmlns/";
  95                 internal const string PrefixXml = "xml";
  96                 internal const string PrefixXmlns = "xmlns";
  97
  98                 #endregion
  99
 100                 #region Constructor
 101
 102                 public XmlNamespaceManager (XmlNameTable nameTable)
 103                 {
 104                         this.nameTable = nameTable;
 105
 106                         nameTable.Add (PrefixXmlns);
 107                         nameTable.Add (PrefixXml);
 108                         nameTable.Add (String.Empty);
 109                         nameTable.Add (XmlnsXmlns);
 110                         nameTable.Add (XmlnsXml);
 111
 112                         InitData ();
 113                 }
 114
 115                 #endregion
 116
 117                 #region Properties
 118
 119                 public virtual string DefaultNamespace {
 120                         get { return defaultNamespace == null ? string.Empty : defaultNamespace; }
 121                 }
 122
 123 #if NET_2_0
 124                 public virtual XmlNameTable NameTable {
 125 #else
 126                 public XmlNameTable NameTable {
 127 #endif
 128                         get { return nameTable; }
 129                 }
 130
 131                 #endregion
 132
 133                 #region Methods
 134
 135                 public virtual void AddNamespace (string prefix, string uri)
 136                 {
 137                         AddNamespace (prefix, uri, false);
 138                 }
 139
 140                 internal virtual void AddNamespace (string prefix, string uri, bool atomizedNames)
 141                 {
 142                         if (prefix == null)
 143                                 throw new ArgumentNullException ("prefix", "Value cannot be null.");
 144
 145                         if (uri == null)
 146                                 throw new ArgumentNullException ("uri", "Value cannot be null.");
 147                         if (!atomizedNames) {
 148                                 prefix = nameTable.Add (prefix);
 149                                 uri = nameTable.Add (uri);
 150                         }
 151
 152                         IsValidDeclaration (prefix, uri, true);
 153
 154                         if (prefix.Length == 0)
 155                                 defaultNamespace = uri;
 156
 157                         for (int i = declPos; i > declPos - count; i--) {
 158                                 if (object.ReferenceEquals (decls [i].Prefix, prefix)) {
 159                                         decls [i].Uri = uri;
 160                                         return;
 161                                 }
 162                         }
 163
 164                         declPos ++;
 165                         count ++;
 166
 167                         if (declPos == decls.Length)
 168                                 GrowDecls ();
 169                         decls [declPos].Prefix = prefix;
 170                         decls [declPos].Uri = uri;
 171                 }
 172
 173                 internal static string IsValidDeclaration (string prefix, string uri, bool throwException)
 174                 {
 175                         string message = null;
 176                         if (prefix == PrefixXml && uri != XmlnsXml)
 177                                 message = String.Format ("Prefix \"xml\" can only be bound to the fixed namespace URI \"{0}\". \"{1}\" is invalid.", XmlnsXml, uri);
 178                         else if (message == null && prefix == "xmlns")
 179                                 message = "Declaring prefix named \"xmlns\" is not allowed to any namespace.";
 180                         else if (message == null && uri == XmlnsXmlns)
 181                                 message = String.Format ("Namespace URI \"{0}\" cannot be declared with any namespace.", XmlnsXmlns);
 182                         if (message != null && throwException)
 183                                 throw new ArgumentException (message);
 184                         else
 185                                 return message;
 186                 }
 187
 188                 public virtual IEnumerator GetEnumerator ()
 189                 {
 190                         // In fact it returns such table's enumerator that contains all the namespaces.
 191                         // while HasNamespace() ignores pushed namespaces.
 192
 193                         Hashtable ht = new Hashtable ();
 194                         for (int i = 0; i <= declPos; i++) {
 195                                 if (decls [i].Prefix != string.Empty && decls [i].Uri != null) {
 196                                         ht [decls [i].Prefix] = decls [i].Uri;
 197                                 }
 198                         }
 199
 200                         ht [string.Empty] = DefaultNamespace;
 201                         ht [PrefixXml] = XmlnsXml;
 202                         ht [PrefixXmlns] = XmlnsXmlns;
 203
 204                         return ht.Keys.GetEnumerator ();
 205                 }
 206
 207 #if NET_2_0
 208                 public virtual IDictionary<string, string> GetNamespacesInScope (XmlNamespaceScope scope)
 209                 {
 210                         IDictionary namespaceTable = GetNamespacesInScopeImpl (scope);
 211                         IDictionary<string, string> namespaces = new Dictionary<string, string>(namespaceTable.Count);
 212
 213                         foreach (DictionaryEntry entry in namespaceTable) {
 214                                 namespaces[(string) entry.Key] = (string) entry.Value;
 215                         }
 216                         return namespaces;
 217                 }
 218 #else
 219                 IDictionary IXmlNamespaceResolver.GetNamespacesInScope (XmlNamespaceScope scope)
 220                 {
 221                         return GetNamespacesInScopeImpl (scope);
 222                 }
 223 #endif
 224
 225                 internal virtual IDictionary GetNamespacesInScopeImpl (XmlNamespaceScope scope)
 226                 {
 227                         Hashtable table = new Hashtable ();
 228
 229                         if (scope == XmlNamespaceScope.Local) {
 230                                 for (int i = 0; i < count; i++)
 231                                         if (decls [declPos - i].Prefix == String.Empty && decls [declPos - i].Uri == String.Empty) {
 232                                                 if (table.Contains (String.Empty))
 233                                                         table.Remove (String.Empty);
 234                                         }
 235                                         else if (decls [declPos - i].Uri != null)
 236                                                 table.Add (decls [declPos - i].Prefix, decls [declPos - i].Uri);
 237                                 return table;
 238                         } else {
 239                                 for (int i = 0; i <= declPos; i++) {
 240                                         if (decls [i].Prefix == String.Empty && decls [i].Uri == String.Empty) {
 241                                                 // removal of default namespace
 242                                                 if (table.Contains (String.Empty))
 243                                                         table.Remove (String.Empty);
 244                                         }
 245                                         else if (decls [i].Uri != null)
 246                                                 table [decls [i].Prefix] = decls [i].Uri;
 247                                 }
 248
 249                                 if (scope == XmlNamespaceScope.All)
 250                                         table.Add ("xml", XmlNamespaceManager.XmlnsXml);
 251                                 return table;
 252                         }
 253                 }
 254
 255                 public virtual bool HasNamespace (string prefix)
 256                 {
 257                         return HasNamespace (prefix, false);
 258                 }
 259
 260                 internal virtual bool HasNamespace (string prefix, bool atomizedNames)
 261                 {
 262                         if (prefix == null || count == 0)
 263                                 return false;
 264
 265                         for (int i = declPos; i > declPos - count; i--) {
 266                                 if (decls [i].Prefix == prefix)
 267                                         return true;
 268                         }
 269
 270                         return false;
 271                 }
 272
 273                 public virtual string LookupNamespace (string prefix)
 274                 {
 275 #if NET_2_0
 276                         return LookupNamespace (prefix, false);
 277 #else
 278                         return LookupNamespace (prefix, true);
 279 #endif
 280                 }
 281
 282                 internal virtual string LookupNamespace (string prefix, bool atomizedNames)
 283                 {
 284                         switch (prefix) {
 285                         case PrefixXmlns:
 286                                 return nameTable.Get (XmlnsXmlns);
 287                         case PrefixXml:
 288                                 return nameTable.Get (XmlnsXml);
 289                         case "":
 290                                 return DefaultNamespace;
 291                         case null:
 292                                 return null;
 293                         }
 294
 295                         for (int i = declPos; i >= 0; i--) {
 296                                 if (CompareString (decls [i].Prefix, prefix, atomizedNames) && decls [i].Uri != null /* null == flag for removed */)
 297                                         return decls [i].Uri;
 298                         }
 299
 300                         return null;
 301                 }
 302
 303                 public virtual string LookupPrefix (string uri)
 304                 {
 305 #if NET_2_0
 306                         return LookupPrefix (uri, false);
 307 #else
 308                         return LookupPrefix (uri, true);
 309 #endif
 310                 }
 311
 312                 private bool CompareString (string s1, string s2, bool atomizedNames)
 313                 {
 314                         if (atomizedNames)
 315                                 return object.ReferenceEquals (s1, s2);
 316                         else
 317                                 return s1 == s2;
 318                 }
 319
 320                 internal string LookupPrefix (string uri, bool atomizedName)
 321                 {
 322                         if (uri == null)
 323                                 return null;
 324
 325                         if (CompareString (uri, DefaultNamespace, atomizedName))
 326                                 return string.Empty;
 327
 328                         if (CompareString (uri, XmlnsXml, atomizedName))
 329                                 return PrefixXml;
 330
 331                         if (CompareString (uri, XmlnsXmlns, atomizedName))
 332                                 return PrefixXmlns;
 333
 334                         for (int i = declPos; i >= 0; i--) {
 335                                 if (CompareString (decls [i].Uri, uri, atomizedName) && decls [i].Prefix.Length > 0) // we already looked for ""
 336                                         return decls [i].Prefix;
 337                         }
 338
 339                         // ECMA specifies that this method returns String.Empty
 340                         // in case of no match. But actually MS.NET returns null.
 341                         // For more information,see
 342                         //  http://lists.ximian.com/archives/public/mono-list/2003-January/005071.html
 343                         //return String.Empty;
 344                         return null;
 345                 }
 346
 347                 public virtual bool PopScope ()
 348                 {
 349                         if (scopePos == -1)
 350                                 return false;
 351
 352                         declPos -= count;
 353                         defaultNamespace = scopes [scopePos].DefaultNamespace;
 354                         count = scopes [scopePos].DeclCount;
 355                         scopePos --;
 356                         return true;
 357                 }
 358
 359                 public virtual void PushScope ()
 360                 {
 361                         scopePos ++;
 362                         if (scopePos == scopes.Length)
 363                                 GrowScopes ();
 364
 365                         scopes [scopePos].DefaultNamespace = defaultNamespace;
 366                         scopes [scopePos].DeclCount = count;
 367                         count = 0;
 368                 }
 369
 370                 // It is rarely used, so we don't need NameTable optimization on it.
 371                 public virtual void RemoveNamespace (string prefix, string uri)
 372                 {
 373                         RemoveNamespace (prefix, uri, false);
 374                 }
 375
 376                 internal virtual void RemoveNamespace (string prefix, string uri, bool atomizedNames)
 377                 {
 378                         if (prefix == null)
 379                                 throw new ArgumentNullException ("prefix");
 380
 381                         if (uri == null)
 382                                 throw new ArgumentNullException ("uri");
 383
 384                         if (count == 0)
 385                                 return;
 386
 387                         for (int i = declPos; i > declPos - count; i--) {
 388                                 if (CompareString (decls [i].Prefix, prefix, atomizedNames) && CompareString (decls [i].Uri, uri, atomizedNames))
 389                                         decls [i].Uri = null;
 390                         }
 391                 }
 392
 393                 #endregion
 394         }
 395 }