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                 public virtual void AddNamespace (string prefix, string uri, bool atomizedNames)
 135 #else
 136                 internal virtual void AddNamespace (string prefix, string uri, bool atomizedNames)
 137 #endif
 138                 {
 139                         if (prefix == null)
 140                                 throw new ArgumentNullException ("prefix", "Value cannot be null.");
 141
 142                         if (uri == null)
 143                                 throw new ArgumentNullException ("uri", "Value cannot be null.");
 144                         if (!atomizedNames) {
 145                                 prefix = nameTable.Add (prefix);
 146                                 uri = nameTable.Add (uri);
 147                         }
 148
 149                         IsValidDeclaration (prefix, uri, true);
 150
 151                         if (prefix.Length == 0)
 152                                 defaultNamespace = uri;
 153
 154                         for (int i = declPos; i > declPos - count; i--) {
 155                                 if (object.ReferenceEquals (decls [i].Prefix, prefix)) {
 156                                         decls [i].Uri = uri;
 157                                         return;
 158                                 }
 159                         }
 160
 161                         declPos ++;
 162                         count ++;
 163
 164                         if (declPos == decls.Length)
 165                                 GrowDecls ();
 166                         decls [declPos].Prefix = prefix;
 167                         decls [declPos].Uri = uri;
 168                 }
 169
 170                 internal static string IsValidDeclaration (string prefix, string uri, bool throwException)
 171                 {
 172                         string message = null;
 173                         if (prefix == PrefixXml && uri != XmlnsXml)
 174                                 message = String.Format ("Prefix \"xml\" is only allowed to the fixed uri \"{0}\"", XmlnsXml);
 175                         else if (uri == XmlnsXml)
 176                                 message = String.Format ("Namespace URI \"{0}\" is reserved to be mapped to \"xml\" and cannot be declared.", XmlnsXml);
 177                         if (message == null && prefix == "xmlns")
 178                                 message = "Declaring prefix named \"xmlns\" is not allowed to any namespace.";
 179                         if (message == null && uri == XmlnsXmlns)
 180                                 message = String.Format ("Namespace URI \"{0}\" cannot be declared with any namespace.", XmlnsXmlns);
 181                         if (message != null && throwException)
 182                                 throw new ArgumentException (message);
 183                         else
 184                                 return message;
 185                 }
 186
 187                 public virtual IEnumerator GetEnumerator ()
 188                 {
 189                         // In fact it returns such table's enumerator that contains all the namespaces.
 190                         // while HasNamespace() ignores pushed namespaces.
 191
 192                         Hashtable ht = new Hashtable ();
 193                         for (int i = 0; i <= declPos; i++) {
 194                                 if (decls [i].Prefix != string.Empty && decls [i].Uri != null) {
 195                                         ht [decls [i].Prefix] = decls [i].Uri;
 196                                 }
 197                         }
 198
 199                         ht [string.Empty] = DefaultNamespace;
 200                         ht [PrefixXml] = XmlnsXml;
 201                         ht [PrefixXmlns] = XmlnsXmlns;
 202
 203                         return ht.Keys.GetEnumerator ();
 204                 }
 205
 206 #if NET_2_0
 207                 public virtual IDictionary GetNamespacesInScope (XmlNamespaceScope scope)
 208 #else
 209                 IDictionary IXmlNamespaceResolver.GetNamespacesInScope (XmlNamespaceScope scope)
 210                 {
 211                         return GetNamespacesInScope (scope);
 212                 }
 213
 214                 internal virtual IDictionary GetNamespacesInScope (XmlNamespaceScope scope)
 215 #endif
 216                 {
 217                         Hashtable table = new Hashtable ();
 218
 219                         if (scope == XmlNamespaceScope.Local) {
 220                                 for (int i = 0; i < count; i++)
 221                                         if (decls [declPos - i].Prefix == String.Empty && decls [declPos - i].Uri == String.Empty) {
 222                                                 if (table.Contains (String.Empty))
 223                                                         table.Remove (String.Empty);
 224                                         }
 225                                         else if (decls [declPos - i].Uri != null)
 226                                                 table.Add (decls [declPos - i].Prefix, decls [declPos - i].Uri);
 227                                 return table;
 228                         }
 229
 230                         for (int i = 0; i < declPos + count; i++) {
 231                                 if (decls [i].Prefix == String.Empty && decls [i].Uri == String.Empty) {
 232                                         if (table.Contains (String.Empty))
 233                                                 table.Remove (String.Empty);
 234                                 }
 235                                 else if (decls [i].Uri != null)
 236                                         table [decls [i].Prefix] = decls [i].Uri;
 237                         }
 238
 239                         if (scope == XmlNamespaceScope.All)
 240                                 table.Add ("xml", XmlNamespaceManager.XmlnsXml);
 241                         return table;
 242                 }
 243
 244                 public virtual bool HasNamespace (string prefix)
 245                 {
 246                         return HasNamespace (prefix, false);
 247                 }
 248
 249 #if NET_2_0
 250                 public virtual bool HasNamespace (string prefix, bool atomizedNames)
 251 #else
 252                 internal virtual bool HasNamespace (string prefix, bool atomizedNames)
 253 #endif
 254                 {
 255                         if (prefix == null || count == 0)
 256                                 return false;
 257
 258                         for (int i = declPos; i > declPos - count; i--) {
 259                                 if (decls [i].Prefix == prefix)
 260                                         return true;
 261                         }
 262
 263                         return false;
 264                 }
 265
 266                 public virtual string LookupNamespace (string prefix)
 267                 {
 268 #if NET_2_0
 269                         return LookupNamespace (prefix, false);
 270 #else
 271                         return LookupNamespace (prefix, true);
 272 #endif
 273                 }
 274
 275 #if NET_2_0
 276                 public virtual string LookupNamespace (string prefix, bool atomizedNames)
 277 #else
 278                 string IXmlNamespaceResolver.LookupNamespace (string prefix, bool atomizedNames)
 279                 {
 280                         return LookupNamespace (prefix, atomizedNames);
 281                 }
 282
 283                 internal virtual string LookupNamespace (string prefix, bool atomizedNames)
 284 #endif
 285                 {
 286                         switch (prefix) {
 287                         case PrefixXmlns:
 288                                 return nameTable.Get (XmlnsXmlns);
 289                         case PrefixXml:
 290                                 return nameTable.Get (XmlnsXml);
 291                         case "":
 292                                 return DefaultNamespace;
 293                         case null:
 294                                 return null;
 295                         }
 296
 297                         for (int i = declPos; i >= 0; i--) {
 298                                 if (CompareString (decls [i].Prefix, prefix, atomizedNames) && decls [i].Uri != null /* null == flag for removed */)
 299                                         return decls [i].Uri;
 300                         }
 301
 302                         return null;
 303                 }
 304
 305                 public virtual string LookupPrefix (string uri)
 306                 {
 307 #if NET_2_0
 308                         return LookupPrefix (uri, false);
 309 #else
 310                         return LookupPrefix (uri, true);
 311 #endif
 312                 }
 313
 314                 private bool CompareString (string s1, string s2, bool atomizedNames)
 315                 {
 316                         if (atomizedNames)
 317                                 return object.ReferenceEquals (s1, s2);
 318                         else
 319                                 return s1 == s2;
 320                 }
 321
 322 #if NET_2_0
 323                 public string LookupPrefix (string uri, bool atomizedName)
 324 #else
 325                 string IXmlNamespaceResolver.LookupPrefix (string uri, bool atomizedName)
 326                 {
 327                         return LookupPrefix (uri, atomizedName);
 328                 }
 329
 330                 internal string LookupPrefix (string uri, bool atomizedName)
 331 #endif
 332                 {
 333                         if (uri == null)
 334                                 return null;
 335
 336                         if (CompareString (uri, DefaultNamespace, atomizedName))
 337                                 return string.Empty;
 338
 339                         if (CompareString (uri, XmlnsXml, atomizedName))
 340                                 return PrefixXml;
 341
 342                         if (CompareString (uri, XmlnsXmlns, atomizedName))
 343                                 return PrefixXmlns;
 344
 345                         for (int i = declPos; i >= 0; i--) {
 346                                 if (CompareString (decls [i].Uri, uri, atomizedName) && decls [i].Prefix.Length > 0) // we already looked for ""
 347                                         return decls [i].Prefix;
 348                         }
 349
 350                         // ECMA specifies that this method returns String.Empty
 351                         // in case of no match. But actually MS.NET returns null.
 352                         // For more information,see
 353                         //  http://lists.ximian.com/archives/public/mono-list/2003-January/005071.html
 354                         //return String.Empty;
 355                         return null;
 356                 }
 357
 358                 public virtual bool PopScope ()
 359                 {
 360                         if (scopePos == -1)
 361                                 return false;
 362
 363                         declPos -= count;
 364                         defaultNamespace = scopes [scopePos].DefaultNamespace;
 365                         count = scopes [scopePos].DeclCount;
 366                         scopePos --;
 367                         return true;
 368                 }
 369
 370                 public virtual void PushScope ()
 371                 {
 372                         scopePos ++;
 373                         if (scopePos == scopes.Length)
 374                                 GrowScopes ();
 375
 376                         scopes [scopePos].DefaultNamespace = defaultNamespace;
 377                         scopes [scopePos].DeclCount = count;
 378                         count = 0;
 379                 }
 380
 381                 // It is rarely used, so we don't need NameTable optimization on it.
 382                 public virtual void RemoveNamespace (string prefix, string uri)
 383                 {
 384                         RemoveNamespace (prefix, uri, false);
 385                 }
 386
 387 #if NET_2_0
 388                 public virtual void RemoveNamespace (string prefix, string uri, bool atomizedNames)
 389 #else
 390                 internal virtual void RemoveNamespace (string prefix, string uri, bool atomizedNames)
 391 #endif
 392                 {
 393                         if (prefix == null)
 394                                 throw new ArgumentNullException ("prefix");
 395
 396                         if (uri == null)
 397                                 throw new ArgumentNullException ("uri");
 398
 399                         if (count == 0)
 400                                 return;
 401
 402                         for (int i = declPos; i > declPos - count; i--) {
 403                                 if (CompareString (decls [i].Prefix, prefix, atomizedNames) && CompareString (decls [i].Uri, uri, atomizedNames))
 404                                         decls [i].Uri = null;
 405                         }
 406                 }
 407
 408                 #endregion
 409         }
 410 }