Unreviewed, rolling out r123184, r123195, and r123197.
[WebKit-https.git] / Source / WebCore / dom / TreeScope.h
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 #ifndef TreeScope_h
27 #define TreeScope_h
28
29 #include "DocumentOrderedMap.h"
30 #include <wtf/Forward.h>
31 #include <wtf/text/AtomicString.h>
32
33 namespace WebCore {
34
35 class ContainerNode;
36 class DOMSelection;
37 class Element;
38 class HTMLMapElement;
39 class IdTargetObserverRegistry;
40 class Node;
41
42 // A class which inherits both Node and TreeScope must call clearRareData() in its destructor
43 // so that the Node destructor no longer does problematic NodeList cache manipulation in
44 // the destructor.
45 class TreeScope {
46     friend class Document;
47
48 public:
49     TreeScope* parentTreeScope() const { return m_parentTreeScope; }
50     void setParentTreeScope(TreeScope*);
51
52     Node* focusedNode();
53     Element* getElementById(const AtomicString&) const;
54     bool hasElementWithId(AtomicStringImpl* id) const;
55     bool containsMultipleElementsWithId(const AtomicString& id) const;
56     void addElementById(const AtomicString& elementId, Element*);
57     void removeElementById(const AtomicString& elementId, Element*);
58
59     Node* ancestorInThisScope(Node*) const;
60
61     void addImageMap(HTMLMapElement*);
62     void removeImageMap(HTMLMapElement*);
63     HTMLMapElement* getImageMap(const String& url) const;
64
65     DOMSelection* getSelection() const;
66
67     // Find first anchor with the given name.
68     // First searches for an element with the given ID, but if that fails, then looks
69     // for an anchor with the given name. ID matching is always case sensitive, but
70     // Anchor name matching is case sensitive in strict mode and not case sensitive in
71     // quirks mode for historical compatibility reasons.
72     Element* findAnchor(const String& name);
73
74     virtual bool applyAuthorStyles() const;
75     virtual bool resetStyleInheritance() const;
76
77     // Used by the basic DOM mutation methods (e.g., appendChild()).
78     void adoptIfNeeded(Node*);
79
80     ContainerNode* rootNode() const { return m_rootNode; }
81
82     IdTargetObserverRegistry& idTargetObserverRegistry() const { return *m_idTargetObserverRegistry.get(); }
83
84 protected:
85     TreeScope(ContainerNode*);
86     virtual ~TreeScope();
87
88     void destroyTreeScopeData();
89
90 private:
91     ContainerNode* m_rootNode;
92     TreeScope* m_parentTreeScope;
93
94     DocumentOrderedMap m_elementsById;
95     DocumentOrderedMap m_imageMapsByName;
96
97     OwnPtr<IdTargetObserverRegistry> m_idTargetObserverRegistry;
98
99     mutable RefPtr<DOMSelection> m_selection;
100 };
101
102 inline bool TreeScope::hasElementWithId(AtomicStringImpl* id) const
103 {
104     ASSERT(id);
105     return m_elementsById.contains(id);
106 }
107
108 inline bool TreeScope::containsMultipleElementsWithId(const AtomicString& id) const
109 {
110     return m_elementsById.containsMultiple(id.impl());
111 }
112
113 TreeScope* commonTreeScope(Node*, Node*);
114
115 } // namespace WebCore
116
117 #endif // TreeScope_h