3ec5e3ce94b6dcd8defd7a850cfad7f143da4a11
[WebKit-https.git] / Source / WebCore / dom / TreeScope.cpp
1 /*
2  * Copyright (C) 2011 Google Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "TreeScope.h"
28
29 #include "ComposedShadowTreeWalker.h"
30 #include "ContainerNode.h"
31 #include "ContextFeatures.h"
32 #include "DOMSelection.h"
33 #include "DOMWindow.h"
34 #include "Document.h"
35 #include "Element.h"
36 #include "FocusController.h"
37 #include "Frame.h"
38 #include "HTMLAnchorElement.h"
39 #include "HTMLFrameOwnerElement.h"
40 #include "HTMLMapElement.h"
41 #include "HTMLNames.h"
42 #include "IdTargetObserverRegistry.h"
43 #include "InsertionPoint.h"
44 #include "Page.h"
45 #include "ShadowRoot.h"
46 #include "TreeScopeAdopter.h"
47 #include <wtf/Vector.h>
48 #include <wtf/text/AtomicString.h>
49 #include <wtf/text/CString.h>
50
51 namespace WebCore {
52
53 using namespace HTMLNames;
54
55 TreeScope::TreeScope(ContainerNode* rootNode, Document* rootDocument)
56     : m_rootNode(rootNode)
57     , m_rootDocument(rootDocument)
58     , m_parentTreeScope(rootNode == rootDocument ? 0 : rootDocument)
59     , m_idTargetObserverRegistry(IdTargetObserverRegistry::create())
60 {
61     ASSERT(rootNode);
62 }
63
64 TreeScope::TreeScope()
65     : m_rootNode(0)
66     , m_rootDocument(0)
67     , m_parentTreeScope(0)
68 {
69 }
70
71 TreeScope::~TreeScope()
72 {
73     if (m_selection) {
74         m_selection->clearTreeScope();
75         m_selection = 0;
76     }
77 }
78
79 void TreeScope::destroyTreeScopeData()
80 {
81     m_elementsById.clear();
82     m_imageMapsByName.clear();
83 }
84
85 void TreeScope::setParentTreeScope(TreeScope* newParentScope)
86 {
87     // A document node cannot be re-parented.
88     ASSERT(!rootNode()->isDocumentNode());
89     // Every scope other than document needs a parent scope.
90     ASSERT(newParentScope);
91
92     m_parentTreeScope = newParentScope;
93     m_rootDocument = newParentScope->rootDocument();
94 }
95
96 Element* TreeScope::getElementById(const AtomicString& elementId) const
97 {
98     if (elementId.isEmpty())
99         return 0;
100     return m_elementsById.getElementById(elementId.impl(), this);
101 }
102
103 void TreeScope::addElementById(const AtomicString& elementId, Element* element)
104 {
105     m_elementsById.add(elementId.impl(), element);
106     m_idTargetObserverRegistry->notifyObservers(elementId);
107 }
108
109 void TreeScope::removeElementById(const AtomicString& elementId, Element* element)
110 {
111     m_elementsById.remove(elementId.impl(), element);
112     m_idTargetObserverRegistry->notifyObservers(elementId);
113 }
114
115 Node* TreeScope::ancestorInThisScope(Node* node) const
116 {
117     while (node) {
118         if (node->treeScope() == this)
119             return node;
120         if (!node->isInShadowTree())
121             return 0;
122         node = node->shadowAncestorNode();
123     }
124
125     return 0;
126 }
127
128 void TreeScope::addImageMap(HTMLMapElement* imageMap)
129 {
130     AtomicStringImpl* name = imageMap->getName().impl();
131     if (!name)
132         return;
133     m_imageMapsByName.add(name, imageMap);
134 }
135
136 void TreeScope::removeImageMap(HTMLMapElement* imageMap)
137 {
138     AtomicStringImpl* name = imageMap->getName().impl();
139     if (!name)
140         return;
141     m_imageMapsByName.remove(name, imageMap);
142 }
143
144 HTMLMapElement* TreeScope::getImageMap(const String& url) const
145 {
146     if (url.isNull())
147         return 0;
148     size_t hashPos = url.find('#');
149     String name = (hashPos == notFound ? url : url.substring(hashPos + 1)).impl();
150     if (rootNode()->document()->isHTMLDocument())
151         return static_cast<HTMLMapElement*>(m_imageMapsByName.getElementByLowercasedMapName(AtomicString(name.lower()).impl(), this));
152     return static_cast<HTMLMapElement*>(m_imageMapsByName.getElementByMapName(AtomicString(name).impl(), this));
153 }
154
155 DOMSelection* TreeScope::getSelection() const
156 {
157     if (!rootNode()->document()->frame())
158         return 0;
159
160     if (m_selection)
161         return m_selection.get();
162
163     // FIXME: The correct selection in Shadow DOM requires that Position can have a ShadowRoot
164     // as a container. It is now enabled only if runtime Shadow DOM feature is enabled.
165     // See https://bugs.webkit.org/show_bug.cgi?id=82697
166 #if ENABLE(SHADOW_DOM)
167     if (ContextFeatures::shadowDOMEnabled(rootNode()->document())) {
168         m_selection = DOMSelection::create(this);
169         return m_selection.get();
170     }
171 #endif
172
173     if (this != rootNode()->document())
174         return rootNode()->document()->getSelection();
175
176     m_selection = DOMSelection::create(rootNode()->document());
177     return m_selection.get();
178 }
179
180 Element* TreeScope::findAnchor(const String& name)
181 {
182     if (name.isEmpty())
183         return 0;
184     if (Element* element = getElementById(name))
185         return element;
186     for (Node* node = rootNode(); node; node = node->traverseNextNode()) {
187         if (node->hasTagName(aTag)) {
188             HTMLAnchorElement* anchor = static_cast<HTMLAnchorElement*>(node);
189             if (rootNode()->document()->inQuirksMode()) {
190                 // Quirks mode, case insensitive comparison of names.
191                 if (equalIgnoringCase(anchor->name(), name))
192                     return anchor;
193             } else {
194                 // Strict mode, names need to match exactly.
195                 if (anchor->name() == name)
196                     return anchor;
197             }
198         }
199     }
200     return 0;
201 }
202
203 bool TreeScope::applyAuthorStyles() const
204 {
205     return true;
206 }
207
208 bool TreeScope::resetStyleInheritance() const
209 {
210     return false;
211 }
212
213 void TreeScope::adoptIfNeeded(Node* node)
214 {
215     ASSERT(this);
216     ASSERT(node);
217     ASSERT(!node->isDocumentNode());
218     ASSERT(!node->m_deletionHasBegun);
219     TreeScopeAdopter adopter(node, this);
220     if (adopter.needsScopeChange())
221         adopter.execute();
222 }
223
224 static Node* focusedFrameOwnerElement(Frame* focusedFrame, Frame* currentFrame)
225 {
226     for (; focusedFrame; focusedFrame = focusedFrame->tree()->parent()) {
227         if (focusedFrame->tree()->parent() == currentFrame)
228             return focusedFrame->ownerElement();
229     }
230     return 0;
231 }
232
233 Node* TreeScope::focusedNode()
234 {
235     Document* document = rootNode()->document();
236     Node* node = document->focusedNode();
237     if (!node && document->page())
238         node = focusedFrameOwnerElement(document->page()->focusController()->focusedFrame(), document->frame());
239     if (!node)
240         return 0;
241     Vector<Node*> targetStack;
242     Node* last = 0;
243     for (ComposedShadowTreeParentWalker walker(node); walker.get(); walker.parentIncludingInsertionPointAndShadowRoot()) {
244         Node* node = walker.get();
245         if (targetStack.isEmpty())
246             targetStack.append(node);
247         else if (isInsertionPoint(node) && toInsertionPoint(node)->contains(last))
248             targetStack.append(targetStack.last());
249         if (node == rootNode())
250             return targetStack.last();
251         last = node;
252         if (node->isShadowRoot()) {
253             ASSERT(!targetStack.isEmpty());
254             targetStack.removeLast();
255         }
256     }
257     return 0;
258 }
259
260 bool TreeScope::isDocumentScope() const
261 {
262     return this == m_rootDocument;
263 }
264
265 static void listTreeScopes(Node* node, Vector<TreeScope*, 5>& treeScopes)
266 {
267     while (true) {
268         treeScopes.append(node->treeScope());
269         Element* ancestor = node->shadowHost();
270         if (!ancestor)
271             break;
272         node = ancestor;
273     }
274 }
275
276 TreeScope* commonTreeScope(Node* nodeA, Node* nodeB)
277 {
278     if (!nodeA || !nodeB)
279         return 0;
280
281     if (nodeA->treeScope() == nodeB->treeScope())
282         return nodeA->treeScope();
283
284     Vector<TreeScope*, 5> treeScopesA;
285     listTreeScopes(nodeA, treeScopesA);
286
287     Vector<TreeScope*, 5> treeScopesB;
288     listTreeScopes(nodeB, treeScopesB);
289
290     size_t indexA = treeScopesA.size();
291     size_t indexB = treeScopesB.size();
292
293     for (; indexA > 0 && indexB > 0 && treeScopesA[indexA - 1] == treeScopesB[indexB - 1]; --indexA, --indexB) { }
294
295     return treeScopesA[indexA] == treeScopesB[indexB] ? treeScopesA[indexA] : 0;
296 }
297
298 TreeScope* TreeScope::nullInstance()
299 {
300     DEFINE_STATIC_LOCAL(TreeScope, instance, ());
301     return &instance;
302 }
303
304 } // namespace WebCore
305