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 using System.Collections.Specialized;
  37
  38 namespace System.Xml
  39 {
  40         public class XmlNamespaceManager : IXmlNamespaceResolver, IEnumerable
  41         {
  42                 #region Data
  43                 struct NsDecl {
  44                         public string Prefix, Uri;
  45                 }
  46
  47                 struct NsScope {
  48                         public int DeclCount;
  49                         public string DefaultNamespace;
  50                 }
  51
  52                 NsDecl [] decls;
  53                 int declPos = -1;
  54
  55                 NsScope [] scopes;
  56                 int scopePos = -1;
  57
  58                 string defaultNamespace;
  59                 int count;
  60
  61                 void InitData ()
  62                 {
  63                         decls = new NsDecl [10];
  64                         scopes = new NsScope [40];
  65                 }
  66
  67                 // precondition declPos == nsDecl.Length
  68                 void GrowDecls ()
  69                 {
  70                         NsDecl [] old = decls;
  71                         decls = new NsDecl [declPos * 2 + 1];
  72                         if (declPos > 0)
  73                                 Array.Copy (old, 0, decls, 0, declPos);
  74                 }
  75
  76                 // precondition scopePos == scopes.Length
  77                 void GrowScopes ()
  78                 {
  79                         NsScope [] old = scopes;
  80                         scopes = new NsScope [scopePos * 2 + 1];
  81                         if (scopePos > 0)
  82                                 Array.Copy (old, 0, scopes, 0, scopePos);
  83                 }
  84
  85                 #endregion
  86
  87                 #region Fields
  88
  89                 private XmlNameTable nameTable;
  90                 internal const string XmlnsXml = "http://www.w3.org/XML/1998/namespace";
  91                 internal const string XmlnsXmlns = "http://www.w3.org/2000/xmlns/";
  92                 internal const string PrefixXml = "xml";
  93                 internal const string PrefixXmlns = "xmlns";
  94
  95                 #endregion
  96
  97                 #region Constructor
  98
  99                 public XmlNamespaceManager (XmlNameTable nameTable)
 100                 {
 101                         this.nameTable = nameTable;
 102
 103                         nameTable.Add (PrefixXmlns);
 104                         nameTable.Add (PrefixXml);
 105                         nameTable.Add (String.Empty);
 106                         nameTable.Add (XmlnsXmlns);
 107                         nameTable.Add (XmlnsXml);
 108
 109                         InitData ();
 110                 }
 111
 112                 #endregion
 113
 114                 #region Properties
 115
 116                 public virtual string DefaultNamespace {
 117                         get { return defaultNamespace == null ? string.Empty : defaultNamespace; }
 118                 }
 119
 120                 public XmlNameTable NameTable {
 121                         get { return nameTable; }
 122                 }
 123
 124                 #endregion
 125
 126                 #region Methods
 127
 128                 public virtual void AddNamespace (string prefix, string uri)
 129                 {
 130                         AddNamespace (prefix, uri, false);
 131                 }
 132
 133 #if NET_2_0
 134                 [Obsolete]
 135                 public virtual void AddNamespace (string prefix, string uri, bool atomizedNames)
 136 #else
 137                 internal virtual void AddNamespace (string prefix, string uri, bool atomizedNames)
 138 #endif
 139                 {
 140                         if (prefix == null)
 141                                 throw new ArgumentNullException ("prefix", "Value cannot be null.");
 142
 143                         if (uri == null)
 144                                 throw new ArgumentNullException ("uri", "Value cannot be null.");
 145                         if (!atomizedNames) {
 146                                 prefix = nameTable.Add (prefix);
 147                                 uri = nameTable.Add (uri);
 148                         }
 149
 150                         IsValidDeclaration (prefix, uri, true);
 151
 152                         if (prefix.Length == 0)
 153                                 defaultNamespace = uri;
 154
 155                         for (int i = declPos; i > declPos - count; i--) {
 156                                 if (object.ReferenceEquals (decls [i].Prefix, prefix)) {
 157                                         decls [i].Uri = uri;
 158                                         return;
 159                                 }
 160                         }
 161
 162                         declPos ++;
 163                         count ++;
 164
 165                         if (declPos == decls.Length)
 166                                 GrowDecls ();
 167                         decls [declPos].Prefix = prefix;
 168                         decls [declPos].Uri = uri;
 169                 }
 170
 171                 internal static string IsValidDeclaration (string prefix, string uri, bool throwException)
 172                 {
 173                         string message = null;
 174                         if (prefix == PrefixXml && uri != XmlnsXml)
 175                                 message = String.Format ("Prefix \"xml\" is only allowed to the fixed uri \"{0}\"", XmlnsXml);
 176                         else if (uri == XmlnsXml)
 177                                 message = String.Format ("Namespace URI \"{0}\" is reserved to be mapped to \"xml\" and cannot be declared.", XmlnsXml);
 178                         if (message == null && prefix == "xmlns")
 179                                 message = "Declaring prefix named \"xmlns\" is not allowed to any namespace.";
 180                         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 GetNamespacesInScope (XmlNamespaceScope scope)
 209 #else
 210                 IDictionary IXmlNamespaceResolver.GetNamespacesInScope (XmlNamespaceScope scope)
 211                 {
 212                         return GetNamespacesInScope (scope);
 213                 }
 214
 215                 internal virtual IDictionary GetNamespacesInScope (XmlNamespaceScope scope)
 216 #endif
 217                 {
 218                         Hashtable table = new Hashtable ();
 219
 220                         if (scope == XmlNamespaceScope.Local) {
 221                                 for (int i = 0; i < count; i++)
 222                                         if (decls [declPos - i].Prefix == String.Empty && decls [declPos - i].Uri == String.Empty) {
 223                                                 if (table.Contains (String.Empty))
 224                                                         table.Remove (String.Empty);
 225                                         }
 226                                         else if (decls [declPos - i].Uri != null)
 227                                                 table.Add (decls [declPos - i].Prefix, decls [declPos - i].Uri);
 228                                 return table;
 229                         } else {
 230                                 for (int i = 0; i <= declPos; i++) {
 231                                         if (decls [i].Prefix == String.Empty && decls [i].Uri == String.Empty) {
 232                                                 // removal of default namespace
 233                                                 if (table.Contains (String.Empty))
 234                                                         table.Remove (String.Empty);
 235                                         }
 236                                         else if (decls [i].Uri != null)
 237                                                 table [decls [i].Prefix] = decls [i].Uri;
 238                                 }
 239
 240                                 if (scope == XmlNamespaceScope.All)
 241                                         table.Add ("xml", XmlNamespaceManager.XmlnsXml);
 242                                 return table;
 243                         }
 244                 }
 245
 246                 public virtual bool HasNamespace (string prefix)
 247                 {
 248                         return HasNamespace (prefix, false);
 249                 }
 250
 251 #if NET_2_0
 252                 [Obsolete]
 253                 public virtual bool HasNamespace (string prefix, bool atomizedNames)
 254 #else
 255                 internal virtual bool HasNamespace (string prefix, bool atomizedNames)
 256 #endif
 257                 {
 258                         if (prefix == null || count == 0)
 259                                 return false;
 260
 261                         for (int i = declPos; i > declPos - count; i--) {
 262                                 if (decls [i].Prefix == prefix)
 263                                         return true;
 264                         }
 265
 266                         return false;
 267                 }
 268
 269                 public virtual string LookupNamespace (string prefix)
 270                 {
 271 #if NET_2_0
 272                         return LookupNamespace (prefix, false);
 273 #else
 274                         return LookupNamespace (prefix, true);
 275 #endif
 276                 }
 277
 278 #if NET_2_0
 279                 [Obsolete]
 280                 public virtual string LookupNamespace (string prefix, bool atomizedNames)
 281 #else
 282                 string IXmlNamespaceResolver.LookupNamespace (string prefix, bool atomizedNames)
 283                 {
 284                         return LookupNamespace (prefix, atomizedNames);
 285                 }
 286
 287                 internal virtual string LookupNamespace (string prefix, bool atomizedNames)
 288 #endif
 289                 {
 290                         switch (prefix) {
 291                         case PrefixXmlns:
 292                                 return nameTable.Get (XmlnsXmlns);
 293                         case PrefixXml:
 294                                 return nameTable.Get (XmlnsXml);
 295                         case "":
 296                                 return DefaultNamespace;
 297                         case null:
 298                                 return null;
 299                         }
 300
 301                         for (int i = declPos; i >= 0; i--) {
 302                                 if (CompareString (decls [i].Prefix, prefix, atomizedNames) && decls [i].Uri != null /* null == flag for removed */)
 303                                         return decls [i].Uri;
 304                         }
 305
 306                         return null;
 307                 }
 308
 309                 public virtual string LookupPrefix (string uri)
 310                 {
 311 #if NET_2_0
 312                         return LookupPrefix (uri, false);
 313 #else
 314                         return LookupPrefix (uri, true);
 315 #endif
 316                 }
 317
 318                 private bool CompareString (string s1, string s2, bool atomizedNames)
 319                 {
 320                         if (atomizedNames)
 321                                 return object.ReferenceEquals (s1, s2);
 322                         else
 323                                 return s1 == s2;
 324                 }
 325
 326 #if NET_2_0
 327                 [Obsolete]
 328                 public string LookupPrefix (string uri, bool atomizedName)
 329 #else
 330                 string IXmlNamespaceResolver.LookupPrefix (string uri, bool atomizedName)
 331                 {
 332                         return LookupPrefix (uri, atomizedName);
 333                 }
 334
 335                 internal string LookupPrefix (string uri, bool atomizedName)
 336 #endif
 337                 {
 338                         if (uri == null)
 339                                 return null;
 340
 341                         if (CompareString (uri, DefaultNamespace, atomizedName))
 342                                 return string.Empty;
 343
 344                         if (CompareString (uri, XmlnsXml, atomizedName))
 345                                 return PrefixXml;
 346
 347                         if (CompareString (uri, XmlnsXmlns, atomizedName))
 348                                 return PrefixXmlns;
 349
 350                         for (int i = declPos; i >= 0; i--) {
 351                                 if (CompareString (decls [i].Uri, uri, atomizedName) && decls [i].Prefix.Length > 0) // we already looked for ""
 352                                         return decls [i].Prefix;
 353                         }
 354
 355                         // ECMA specifies that this method returns String.Empty
 356                         // in case of no match. But actually MS.NET returns null.
 357                         // For more information,see
 358                         //  http://lists.ximian.com/archives/public/mono-list/2003-January/005071.html
 359                         //return String.Empty;
 360                         return null;
 361                 }
 362
 363                 public virtual bool PopScope ()
 364                 {
 365                         if (scopePos == -1)
 366                                 return false;
 367
 368                         declPos -= count;
 369                         defaultNamespace = scopes [scopePos].DefaultNamespace;
 370                         count = scopes [scopePos].DeclCount;
 371                         scopePos --;
 372                         return true;
 373                 }
 374
 375                 public virtual void PushScope ()
 376                 {
 377                         scopePos ++;
 378                         if (scopePos == scopes.Length)
 379                                 GrowScopes ();
 380
 381                         scopes [scopePos].DefaultNamespace = defaultNamespace;
 382                         scopes [scopePos].DeclCount = count;
 383                         count = 0;
 384                 }
 385
 386                 // It is rarely used, so we don't need NameTable optimization on it.
 387                 public virtual void RemoveNamespace (string prefix, string uri)
 388                 {
 389                         RemoveNamespace (prefix, uri, false);
 390                 }
 391
 392 #if NET_2_0
 393                 [Obsolete]
 394                 public virtual void RemoveNamespace (string prefix, string uri, bool atomizedNames)
 395 #else
 396                 internal virtual void RemoveNamespace (string prefix, string uri, bool atomizedNames)
 397 #endif
 398                 {
 399                         if (prefix == null)
 400                                 throw new ArgumentNullException ("prefix");
 401
 402                         if (uri == null)
 403                                 throw new ArgumentNullException ("uri");
 404
 405                         if (count == 0)
 406                                 return;
 407
 408                         for (int i = declPos; i > declPos - count; i--) {
 409                                 if (CompareString (decls [i].Prefix, prefix, atomizedNames) && CompareString (decls [i].Uri, uri, atomizedNames))
 410                                         decls [i].Uri = null;
 411                         }
 412                 }
 413
 414                 #endregion
 415         }
 416 }