2f38c19845180ca16e4d17f484ed44433b9992ed
[WebKit-https.git] / Source / WebCore / dom / QualifiedName.h
1 /*
2  * Copyright (C) 2005-2017 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 #pragma once
22
23 #include <wtf/HashTraits.h>
24 #include <wtf/text/AtomicString.h>
25
26 namespace WebCore {
27
28 struct QualifiedNameComponents {
29     StringImpl* m_prefix;
30     StringImpl* m_localName;
31     StringImpl* m_namespace;
32 };
33
34 class QualifiedName {
35     WTF_MAKE_FAST_ALLOCATED;
36 public:
37     class QualifiedNameImpl : public RefCounted<QualifiedNameImpl> {
38     public:
39         static Ref<QualifiedNameImpl> create(const AtomicString& prefix, const AtomicString& localName, const AtomicString& namespaceURI)
40         {
41             return adoptRef(*new QualifiedNameImpl(prefix, localName, namespaceURI));
42         }
43
44         WEBCORE_EXPORT ~QualifiedNameImpl();
45
46         unsigned computeHash() const;
47
48         mutable unsigned m_existingHash { 0 };
49         const AtomicString m_prefix;
50         const AtomicString m_localName;
51         const AtomicString m_namespace;
52         mutable AtomicString m_localNameUpper;
53
54 #if ENABLE(JIT)
55         static ptrdiff_t localNameMemoryOffset() { return OBJECT_OFFSETOF(QualifiedNameImpl, m_localName); }
56         static ptrdiff_t namespaceMemoryOffset() { return OBJECT_OFFSETOF(QualifiedNameImpl, m_namespace); }
57 #endif
58
59     private:
60         QualifiedNameImpl(const AtomicString& prefix, const AtomicString& localName, const AtomicString& namespaceURI)
61             : m_prefix(prefix)
62             , m_localName(localName)
63             , m_namespace(namespaceURI)
64         {
65             ASSERT(!namespaceURI.isEmpty() || namespaceURI.isNull());
66         }        
67     };
68
69     WEBCORE_EXPORT QualifiedName(const AtomicString& prefix, const AtomicString& localName, const AtomicString& namespaceURI);
70     explicit QualifiedName(WTF::HashTableDeletedValueType) : m_impl(WTF::HashTableDeletedValue) { }
71     bool isHashTableDeletedValue() const { return m_impl.isHashTableDeletedValue(); }
72 #ifdef QNAME_DEFAULT_CONSTRUCTOR
73     QualifiedName() { }
74 #endif
75
76     bool operator==(const QualifiedName& other) const { return m_impl == other.m_impl; }
77     bool operator!=(const QualifiedName& other) const { return !(*this == other); }
78
79     bool matches(const QualifiedName& other) const { return m_impl == other.m_impl || (localName() == other.localName() && namespaceURI() == other.namespaceURI()); }
80
81     bool hasPrefix() const { return !m_impl->m_prefix.isNull(); }
82     void setPrefix(const AtomicString& prefix) { *this = QualifiedName(prefix, localName(), namespaceURI()); }
83
84     const AtomicString& prefix() const { return m_impl->m_prefix; }
85     const AtomicString& localName() const { return m_impl->m_localName; }
86     const AtomicString& namespaceURI() const { return m_impl->m_namespace; }
87
88     // Uppercased localName, cached for efficiency
89     const AtomicString& localNameUpper() const;
90
91     String toString() const;
92
93     QualifiedNameImpl* impl() const { return m_impl.get(); }
94 #if ENABLE(JIT)
95     static ptrdiff_t implMemoryOffset() { return OBJECT_OFFSETOF(QualifiedName, m_impl); }
96 #endif
97     
98     // Init routine for globals
99     static void init();
100
101 private:
102     static QualifiedNameImpl* hashTableDeletedValue() { return RefPtr<QualifiedNameImpl>::hashTableDeletedValue(); }
103     
104     RefPtr<QualifiedNameImpl> m_impl;
105 };
106
107 #ifndef WEBCORE_QUALIFIEDNAME_HIDE_GLOBALS
108 extern const QualifiedName anyName;
109 inline const QualifiedName& anyQName() { return anyName; }
110 #endif
111
112 const QualifiedName& nullQName();
113
114 inline bool operator==(const AtomicString& a, const QualifiedName& q) { return a == q.localName(); }
115 inline bool operator!=(const AtomicString& a, const QualifiedName& q) { return a != q.localName(); }
116 inline bool operator==(const QualifiedName& q, const AtomicString& a) { return a == q.localName(); }
117 inline bool operator!=(const QualifiedName& q, const AtomicString& a) { return a != q.localName(); }
118
119 inline unsigned hashComponents(const QualifiedNameComponents& buf)
120 {
121     return StringHasher::hashMemory<sizeof(QualifiedNameComponents)>(&buf);
122 }
123
124 struct QualifiedNameHash {
125     static unsigned hash(const QualifiedName& name) { return hash(name.impl()); }
126
127     static unsigned hash(const QualifiedName::QualifiedNameImpl* name) 
128     {
129         if (!name->m_existingHash)
130             name->m_existingHash = name->computeHash();
131         return name->m_existingHash;
132     }
133
134     static bool equal(const QualifiedName& a, const QualifiedName& b) { return a == b; }
135     static bool equal(const QualifiedName::QualifiedNameImpl* a, const QualifiedName::QualifiedNameImpl* b) { return a == b; }
136
137     static const bool safeToCompareToEmptyOrDeleted = false;
138 };
139
140 void createQualifiedName(void* targetAddress, StringImpl* name);
141 void createQualifiedName(void* targetAddress, StringImpl* name, const AtomicString& nameNamespace);
142
143 inline String QualifiedName::toString() const
144 {
145     if (!hasPrefix())
146         return localName();
147
148     return prefix().string() + ':' + localName().string();
149 }
150
151 } // namespace WebCore
152
153 namespace WTF {
154     
155     template<typename T> struct DefaultHash;
156
157     template<> struct DefaultHash<WebCore::QualifiedName> {
158         typedef WebCore::QualifiedNameHash Hash;
159     };
160     
161     template<> struct HashTraits<WebCore::QualifiedName> : SimpleClassHashTraits<WebCore::QualifiedName> {
162         static const bool emptyValueIsZero = false;
163         static WebCore::QualifiedName emptyValue() { return WebCore::nullQName(); }
164     };
165
166 } // namespace WTF