636b2a5150c9e987c027e7569792d9bac34a89e9
[WebKit-https.git] / Source / WebCore / dom / QualifiedName.h
1 /*
2  * Copyright (C) 2005, 2006, 2009 Apple Inc. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #ifndef QualifiedName_h
22 #define QualifiedName_h
23
24 #include <wtf/HashTraits.h>
25 #include <wtf/RefCounted.h>
26 #include <wtf/text/AtomicString.h>
27
28 namespace WebCore {
29
30 struct QualifiedNameComponents {
31     StringImpl* m_prefix;
32     StringImpl* m_localName;
33     StringImpl* m_namespace;
34 };
35
36 class QualifiedName {
37     WTF_MAKE_FAST_ALLOCATED;
38 public:
39     class QualifiedNameImpl : public RefCounted<QualifiedNameImpl> {
40     public:
41         static PassRefPtr<QualifiedNameImpl> create(const AtomicString& prefix, const AtomicString& localName, const AtomicString& namespaceURI)
42         {
43             return adoptRef(new QualifiedNameImpl(prefix, localName, namespaceURI));
44         }
45
46         const AtomicString m_prefix;
47         const AtomicString m_localName;
48         const AtomicString m_namespace;
49         mutable AtomicString m_localNameUpper;
50
51     private:
52         QualifiedNameImpl(const AtomicString& prefix, const AtomicString& localName, const AtomicString& namespaceURI)
53             : m_prefix(prefix)
54             , m_localName(localName)
55             , m_namespace(namespaceURI)
56         {
57             ASSERT(!namespaceURI.isEmpty() || namespaceURI.isNull());
58         }        
59     };
60
61     QualifiedName(const AtomicString& prefix, const AtomicString& localName, const AtomicString& namespaceURI);
62     QualifiedName(const AtomicString& prefix, const char* localName, const AtomicString& namespaceURI);
63     QualifiedName(WTF::HashTableDeletedValueType) : m_impl(hashTableDeletedValue()) { }
64     bool isHashTableDeletedValue() const { return m_impl == hashTableDeletedValue(); }
65     ~QualifiedName();
66 #ifdef QNAME_DEFAULT_CONSTRUCTOR
67     QualifiedName() : m_impl(0) { }
68 #endif
69
70     QualifiedName(const QualifiedName& other) : m_impl(other.m_impl) { ref(); }
71     const QualifiedName& operator=(const QualifiedName& other) { other.ref(); deref(); m_impl = other.m_impl; return *this; }
72
73     bool operator==(const QualifiedName& other) const { return m_impl == other.m_impl; }
74     bool operator!=(const QualifiedName& other) const { return !(*this == other); }
75
76     bool matches(const QualifiedName& other) const { return m_impl == other.m_impl || (localName() == other.localName() && namespaceURI() == other.namespaceURI()); }
77
78     bool hasPrefix() const { return m_impl->m_prefix != nullAtom; }
79     void setPrefix(const AtomicString& prefix) { *this = QualifiedName(prefix, localName(), namespaceURI()); }
80
81     const AtomicString& prefix() const { return m_impl->m_prefix; }
82     const AtomicString& localName() const { return m_impl->m_localName; }
83     const AtomicString& namespaceURI() const { return m_impl->m_namespace; }
84
85     // Uppercased localName, cached for efficiency
86     const AtomicString& localNameUpper() const;
87
88     String toString() const;
89
90     QualifiedNameImpl* impl() const { return m_impl; }
91     
92     // Init routine for globals
93     static void init();
94     
95 private:
96     void init(const AtomicString& prefix, const AtomicString& localName, const AtomicString& namespaceURI);
97     void ref() const { m_impl->ref(); }
98     void deref();
99
100     static QualifiedNameImpl* hashTableDeletedValue() { return RefPtr<QualifiedNameImpl>::hashTableDeletedValue(); }
101     
102     QualifiedNameImpl* m_impl;
103 };
104
105 #ifndef WEBCORE_QUALIFIEDNAME_HIDE_GLOBALS
106 extern const QualifiedName anyName;
107 inline const QualifiedName& anyQName() { return anyName; }
108 #endif
109
110 inline bool operator==(const AtomicString& a, const QualifiedName& q) { return a == q.localName(); }
111 inline bool operator!=(const AtomicString& a, const QualifiedName& q) { return a != q.localName(); }
112 inline bool operator==(const QualifiedName& q, const AtomicString& a) { return a == q.localName(); }
113 inline bool operator!=(const QualifiedName& q, const AtomicString& a) { return a != q.localName(); }
114
115 inline unsigned hashComponents(const QualifiedNameComponents& buf)
116 {
117     return StringHasher::hashMemory<sizeof(QualifiedNameComponents)>(&buf);
118 }
119
120 struct QualifiedNameHash {
121     static unsigned hash(const QualifiedName& name) { return hash(name.impl()); }
122
123     static unsigned hash(const QualifiedName::QualifiedNameImpl* name) 
124     {
125         QualifiedNameComponents c = { name->m_prefix.impl(), name->m_localName.impl(), name->m_namespace.impl() };
126         return hashComponents(c);
127     }
128
129     static bool equal(const QualifiedName& a, const QualifiedName& b) { return a == b; }
130     static bool equal(const QualifiedName::QualifiedNameImpl* a, const QualifiedName::QualifiedNameImpl* b) { return a == b; }
131
132     static const bool safeToCompareToEmptyOrDeleted = false;
133 };
134
135 }
136
137 namespace WTF {
138     
139     template<typename T> struct DefaultHash;
140
141     template<> struct DefaultHash<WebCore::QualifiedName> {
142         typedef WebCore::QualifiedNameHash Hash;
143     };
144     
145     template<> struct HashTraits<WebCore::QualifiedName> : SimpleClassHashTraits<WebCore::QualifiedName> {
146         static const bool emptyValueIsZero = false;
147         static WebCore::QualifiedName emptyValue() { return WebCore::QualifiedName(nullAtom, nullAtom, nullAtom); }
148     };
149 }
150
151 #endif