New test.
[mono.git] / mcs / class / System.XML / System.Xml / XmlNamespaceManager.cs
index e2ecc819aa77998ad49759a1d4b458a96b3e36ab..50bb0401b5f37be721d0bd707e4b6bdcfff00530 100644 (file)
@@ -1,22 +1,99 @@
 //
 // XmlNamespaceManager.cs
 //
-// Author:
+// Authors:
 //   Jason Diamond (jason@injektilo.org)
+//   Ben Maurer (bmaurer@users.sourceforge.net)
+//   Atsushi Enomoto (atsushi@ximian.com)
 //
 // (C) 2001 Jason Diamond  http://injektilo.org/
+// (C) 2003 Ben Maurer
+// (C) 2004 Novell Inc.
+//
+
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+// 
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
 using System.Collections;
+#if NET_2_0
+using System.Collections.Generic;
+#endif
+using System.Collections.Specialized;
 
 namespace System.Xml
 {
-       public class XmlNamespaceManager : IEnumerable
+       public class XmlNamespaceManager : IXmlNamespaceResolver, IEnumerable
        {
+               #region Data
+               struct NsDecl {
+                       public string Prefix, Uri;
+               }
+               
+               struct NsScope {
+                       public int DeclCount;
+                       public string DefaultNamespace;
+               }
+               
+               NsDecl [] decls;
+               int declPos = -1;
+               
+               NsScope [] scopes;
+               int scopePos = -1;
+               
+               string defaultNamespace;
+               int count;
+               
+               void InitData ()
+               {
+                       decls = new NsDecl [10];
+                       scopes = new NsScope [40];
+               }
+               
+               // precondition declPos == nsDecl.Length
+               void GrowDecls ()
+               {
+                       NsDecl [] old = decls;
+                       decls = new NsDecl [declPos * 2 + 1];
+                       if (declPos > 0)
+                               Array.Copy (old, 0, decls, 0, declPos);
+               }
+               
+               // precondition scopePos == scopes.Length
+               void GrowScopes ()
+               {
+                       NsScope [] old = scopes;
+                       scopes = new NsScope [scopePos * 2 + 1];
+                       if (scopePos > 0)
+                               Array.Copy (old, 0, scopes, 0, scopePos);
+               }
+               
+               #endregion
+               
                #region Fields
 
                private XmlNameTable nameTable;
-               private NamespaceScope currentScope;
+               internal const string XmlnsXml = "http://www.w3.org/XML/1998/namespace";
+               internal const string XmlnsXmlns = "http://www.w3.org/2000/xmlns/";
+               internal const string PrefixXml = "xml";
+               internal const string PrefixXmlns = "xmlns";
 
                #endregion
 
@@ -26,16 +103,13 @@ namespace System.Xml
                {
                        this.nameTable = nameTable;
 
-                       nameTable.Add ("xmlns");
-                       nameTable.Add ("xml");
+                       nameTable.Add (PrefixXmlns);
+                       nameTable.Add (PrefixXml);
                        nameTable.Add (String.Empty);
-                       nameTable.Add ("http://www.w3.org/2000/xmlns/");
-                       nameTable.Add ("http://www.w3.org/XML/1998/namespace");
-
-                       PushScope ();
-                       currentScope.Namespaces = new Hashtable ();
-                       currentScope.Namespaces.Add ("xml", "http://www.w3.org/XML/1998/namespace");
-                       currentScope.Namespaces.Add ("xmlns", "http://www.w3.org/2000/xmlns/");
+                       nameTable.Add (XmlnsXmlns);
+                       nameTable.Add (XmlnsXml);
+                       
+                       InitData ();
                }
 
                #endregion
@@ -43,10 +117,14 @@ namespace System.Xml
                #region Properties
 
                public virtual string DefaultNamespace {
-                       get { return LookupNamespace (String.Empty); }
+                       get { return defaultNamespace == null ? string.Empty : defaultNamespace; }
                }
 
+#if NET_2_0
+               public virtual XmlNameTable NameTable {
+#else
                public XmlNameTable NameTable {
+#endif
                        get { return nameTable; }
                }
 
@@ -55,76 +133,220 @@ namespace System.Xml
                #region Methods
 
                public virtual void AddNamespace (string prefix, string uri)
+               {
+                       AddNamespace (prefix, uri, false);
+               }
+
+               internal virtual void AddNamespace (string prefix, string uri, bool atomizedNames)
                {
                        if (prefix == null)
                                throw new ArgumentNullException ("prefix", "Value cannot be null.");
 
                        if (uri == null)
                                throw new ArgumentNullException ("uri", "Value cannot be null.");
+                       if (!atomizedNames) {
+                               prefix = nameTable.Add (prefix);
+                               uri = nameTable.Add (uri);
+                       }
 
-                       if (prefix.Length > 2 && prefix.Substring (0, 3).ToLower () == "xml")
-                               throw new ArgumentException ( "Prefixes beginning with \"xml\" (regardless " + "of whether the characters are uppercase, lowercase, or some combination thereof) are reserved for use by XML.", "prefix");
+                       IsValidDeclaration (prefix, uri, true);
 
-                       if (currentScope.Namespaces == null)
-                               currentScope.Namespaces = new Hashtable ();
+                       if (prefix.Length == 0)
+                               defaultNamespace = uri;
+                       
+                       for (int i = declPos; i > declPos - count; i--) {
+                               if (object.ReferenceEquals (decls [i].Prefix, prefix)) {
+                                       decls [i].Uri = uri;
+                                       return;
+                               }
+                       }
+                       
+                       declPos ++;
+                       count ++;
+                       
+                       if (declPos == decls.Length)
+                               GrowDecls ();
+                       decls [declPos].Prefix = prefix;
+                       decls [declPos].Uri = uri;
+               }
 
-                       if (prefix != String.Empty)
-                               nameTable.Add (prefix);
-                       currentScope.Namespaces [prefix] = nameTable.Add (uri);
+               static string IsValidDeclaration (string prefix, string uri, bool throwException)
+               {
+                       string message = null;
+                       // It is funky, but it does not check whether prefix
+                       // is equivalent to "xml" in case-insensitive means.
+                       if (prefix == PrefixXml && uri != XmlnsXml)
+                               message = String.Format ("Prefix \"xml\" can only be bound to the fixed namespace URI \"{0}\". \"{1}\" is invalid.", XmlnsXml, uri);
+                       else if (message == null && prefix == "xmlns")
+                               message = "Declaring prefix named \"xmlns\" is not allowed to any namespace.";
+                       else if (message == null && uri == XmlnsXmlns)
+                               message = String.Format ("Namespace URI \"{0}\" cannot be declared with any namespace.", XmlnsXmlns);
+                       if (message != null && throwException)
+                               throw new ArgumentException (message);
+                       else
+                               return message;
                }
 
                public virtual IEnumerator GetEnumerator ()
                {
-                       if (currentScope.Namespaces == null)
-                               currentScope.Namespaces = new Hashtable ();
+                       // In fact it returns such table's enumerator that contains all the namespaces.
+                       // while HasNamespace() ignores pushed namespaces.
+                       
+                       Hashtable ht = new Hashtable ();
+                       for (int i = 0; i <= declPos; i++) {
+                               if (decls [i].Prefix != string.Empty && decls [i].Uri != null) {
+                                       ht [decls [i].Prefix] = decls [i].Uri;
+                               }
+                       }
+                       
+                       ht [string.Empty] = DefaultNamespace;
+                       ht [PrefixXml] = XmlnsXml;
+                       ht [PrefixXmlns] = XmlnsXmlns;
+                       
+                       return ht.Keys.GetEnumerator ();
+               }
+
+#if NET_2_0
+               public virtual IDictionary<string, string> GetNamespacesInScope (XmlNamespaceScope scope)
+               {
+                       IDictionary namespaceTable = GetNamespacesInScopeImpl (scope);
+                       IDictionary<string, string> namespaces = new Dictionary<string, string>(namespaceTable.Count);
 
-                       return currentScope.Namespaces.Keys.GetEnumerator ();
+                       foreach (DictionaryEntry entry in namespaceTable) {
+                               namespaces[(string) entry.Key] = (string) entry.Value;
+                       }
+                       return namespaces;
+               }
+#else
+               IDictionary IXmlNamespaceResolver.GetNamespacesInScope (XmlNamespaceScope scope)
+               {
+                       return GetNamespacesInScopeImpl (scope);
+               }
+#endif
+
+               internal virtual IDictionary GetNamespacesInScopeImpl (XmlNamespaceScope scope)
+               {
+                       Hashtable table = new Hashtable ();
+
+                       if (scope == XmlNamespaceScope.Local) {
+                               for (int i = 0; i < count; i++)
+                                       if (decls [declPos - i].Prefix == String.Empty && decls [declPos - i].Uri == String.Empty) {
+                                               if (table.Contains (String.Empty))
+                                                       table.Remove (String.Empty);
+                                       }
+                                       else if (decls [declPos - i].Uri != null)
+                                               table.Add (decls [declPos - i].Prefix, decls [declPos - i].Uri);
+                               return table;
+                       } else {
+                               for (int i = 0; i <= declPos; i++) {
+                                       if (decls [i].Prefix == String.Empty && decls [i].Uri == String.Empty) {
+                                               // removal of default namespace
+                                               if (table.Contains (String.Empty))
+                                                       table.Remove (String.Empty);
+                                       }
+                                       else if (decls [i].Uri != null)
+                                               table [decls [i].Prefix] = decls [i].Uri;
+                               }
+
+                               if (scope == XmlNamespaceScope.All)
+                                       table.Add ("xml", XmlNamespaceManager.XmlnsXml);
+                               return table;
+                       }
                }
 
                public virtual bool HasNamespace (string prefix)
                {
-                       return currentScope != null && currentScope.Namespaces != null && currentScope.Namespaces.Contains (prefix);
+                       return HasNamespace (prefix, false);
                }
 
-               public virtual string LookupNamespace (string prefix)
+               internal virtual bool HasNamespace (string prefix, bool atomizedNames)
                {
-                       NamespaceScope scope = currentScope;
+                       if (prefix == null || count == 0)
+                               return false;
 
-                       while (scope != null) {
-                               if (scope.Namespaces != null && scope.Namespaces.Contains (prefix))
-                                       return scope.Namespaces[prefix] as string;
-                               scope = scope.Next;
+                       for (int i = declPos; i > declPos - count; i--) {
+                               if (decls [i].Prefix == prefix)
+                                       return true;
                        }
+                       
+                       return false;
+               }
+
+               public virtual string LookupNamespace (string prefix)
+               {
+#if NET_2_0
+                       return LookupNamespace (prefix, false);
+#else
+                       return LookupNamespace (prefix, true);
+#endif
+               }
 
+               internal virtual string LookupNamespace (string prefix, bool atomizedNames)
+               {
                        switch (prefix) {
-                       case "xmlns":
-                               return nameTable.Get ("http://www.w3.org/2000/xmlns/");
-                       case "xml":
-                               return nameTable.Get ("http://www.w3.org/XML/1998/namespace");
+                       case PrefixXmlns:
+                               return nameTable.Get (XmlnsXmlns);
+                       case PrefixXml:
+                               return nameTable.Get (XmlnsXml);
                        case "":
-                               return nameTable.Get (String.Empty);
+                               return DefaultNamespace;
+                       case null:
+                               return null;
                        }
 
+                       for (int i = declPos; i >= 0; i--) {
+                               if (CompareString (decls [i].Prefix, prefix, atomizedNames) && decls [i].Uri != null /* null == flag for removed */)
+                                       return decls [i].Uri;
+                       }
+                       
                        return null;
                }
 
                public virtual string LookupPrefix (string uri)
                {
+#if NET_2_0
+                       return LookupPrefix (uri, false);
+#else
+                       return LookupPrefix (uri, true);
+#endif
+               }
+
+               private bool CompareString (string s1, string s2, bool atomizedNames)
+               {
+                       if (atomizedNames)
+                               return object.ReferenceEquals (s1, s2);
+                       else
+                               return s1 == s2;
+               }
+
+               internal string LookupPrefix (string uri, bool atomizedName)
+               {
+                       return LookupPrefixCore (uri, atomizedName, false);
+               }
+
+               internal string LookupPrefixExclusive (string uri, bool atomizedName)
+               {
+                       return LookupPrefixCore (uri, atomizedName, true);
+               }
+
+               string LookupPrefixCore (string uri, bool atomizedName, bool excludeOverriden)
+               {
                        if (uri == null)
                                return null;
 
-                       NamespaceScope scope = currentScope;
+                       if (CompareString (uri, DefaultNamespace, atomizedName))
+                               return string.Empty;
 
-                       while (scope != null) 
-                       {
-                               if (scope.Namespaces != null && scope.Namespaces.ContainsValue (uri)) {
-                                       foreach (DictionaryEntry entry in scope.Namespaces) {
-                                               if (entry.Value.ToString() == uri)
-                                                       return nameTable.Get (entry.Key as string) as string;
-                                       }
-                               }
+                       if (CompareString (uri, XmlnsXml, atomizedName))
+                               return PrefixXml;
+                       
+                       if (CompareString (uri, XmlnsXmlns, atomizedName))
+                               return PrefixXmlns;
 
-                               scope = scope.Next;
+                       for (int i = declPos; i >= 0; i--) {
+                               if (CompareString (decls [i].Uri, uri, atomizedName) && decls [i].Prefix.Length > 0) // we already looked for ""
+                                       if (!excludeOverriden || !IsOverriden (i))
+                                               return decls [i].Prefix;
                        }
 
                        // ECMA specifies that this method returns String.Empty
@@ -135,50 +357,63 @@ namespace System.Xml
                        return null;
                }
 
-               public virtual bool PopScope ()
+               bool IsOverriden (int idx)
                {
-                       if (currentScope != null)
-                               currentScope = currentScope.Next;
+                       if (idx == declPos)
+                               return false;
+                       string prefix = decls [idx + 1].Prefix;
+                       for (int i = idx + 1; i <= declPos; i++)
+                               if ((object) decls [idx].Prefix == prefix)
+                                       return true;
+                       return false;
+               }
 
-                       return currentScope != null;
+               public virtual bool PopScope ()
+               {
+                       if (scopePos == -1)
+                               return false;
+
+                       declPos -= count;
+                       defaultNamespace = scopes [scopePos].DefaultNamespace;
+                       count = scopes [scopePos].DeclCount;
+                       scopePos --;
+                       return true;
                }
 
                public virtual void PushScope ()
                {
-                       NamespaceScope newScope = new NamespaceScope ();
-                       newScope.Next = currentScope;
-                       currentScope = newScope;
+                       scopePos ++;
+                       if (scopePos == scopes.Length)
+                               GrowScopes ();
+                       
+                       scopes [scopePos].DefaultNamespace = defaultNamespace;
+                       scopes [scopePos].DeclCount = count;
+                       count = 0;
                }
 
+               // It is rarely used, so we don't need NameTable optimization on it.
                public virtual void RemoveNamespace (string prefix, string uri)
+               {
+                       RemoveNamespace (prefix, uri, false);
+               }
+
+               internal virtual void RemoveNamespace (string prefix, string uri, bool atomizedNames)
                {
                        if (prefix == null)
                                throw new ArgumentNullException ("prefix");
 
                        if (uri == null)
                                throw new ArgumentNullException ("uri");
-
-                       if (currentScope == null || currentScope.Namespaces == null)
-                               return;
-
-                       string p = nameTable.Get (prefix);
-                       string u = nameTable.Get (uri);
-                       if (p == null || u == null)
-                               return;
-                               
-                       string storedUri = currentScope.Namespaces [p] as string;
-                       if (storedUri == null || storedUri != u)
+                       
+                       if (count == 0)
                                return;
 
-                       currentScope.Namespaces.Remove (p);
+                       for (int i = declPos; i > declPos - count; i--) {
+                               if (CompareString (decls [i].Prefix, prefix, atomizedNames) && CompareString (decls [i].Uri, uri, atomizedNames))
+                                       decls [i].Uri = null;
+                       }
                }
 
                #endregion
        }
-
-       internal class NamespaceScope
-       {
-               internal NamespaceScope Next;
-               internal Hashtable Namespaces;
-       }
 }