Unreviewed, rolling out r116715.
[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 Element;
37 class HTMLMapElement;
38 class Node;
39
40 // A class which inherits both Node and TreeScope must call clearRareData() in its destructor
41 // so that the Node destructor no longer does problematic NodeList cache manipulation in
42 // the destructor.
43 class TreeScope {
44     friend class Document;
45
46 public:
47     TreeScope* parentTreeScope() const { return m_parentTreeScope; }
48     void setParentTreeScope(TreeScope*);
49
50     Node* focusedNode();
51     Element* getElementById(const AtomicString&) const;
52     bool hasElementWithId(AtomicStringImpl* id) const;
53     bool containsMultipleElementsWithId(const AtomicString& id) const;
54     void addElementById(const AtomicString& elementId, Element*);
55     void removeElementById(const AtomicString& elementId, Element*);
56
57     void addImageMap(HTMLMapElement*);
58     void removeImageMap(HTMLMapElement*);
59     HTMLMapElement* getImageMap(const String& url) const;
60
61     void addNodeListCache() { ++m_numNodeListCaches; }
62     void removeNodeListCache() { ASSERT(m_numNodeListCaches > 0); --m_numNodeListCaches; }
63     bool hasNodeListCaches() const { return m_numNodeListCaches; }
64
65     // Find first anchor with the given name.
66     // First searches for an element with the given ID, but if that fails, then looks
67     // for an anchor with the given name. ID matching is always case sensitive, but
68     // Anchor name matching is case sensitive in strict mode and not case sensitive in
69     // quirks mode for historical compatibility reasons.
70     Element* findAnchor(const String& name);
71
72     virtual bool applyAuthorStyles() const;
73
74     // Used by the basic DOM mutation methods (e.g., appendChild()).
75     void adoptIfNeeded(Node*);
76
77     ContainerNode* rootNode() const { return m_rootNode; }
78
79 protected:
80     TreeScope(ContainerNode*);
81     virtual ~TreeScope();
82
83     void destroyTreeScopeData();
84
85 private:
86     ContainerNode* m_rootNode;
87     TreeScope* m_parentTreeScope;
88
89     DocumentOrderedMap m_elementsById;
90     DocumentOrderedMap m_imageMapsByName;
91
92     unsigned m_numNodeListCaches;
93 };
94
95 inline bool TreeScope::hasElementWithId(AtomicStringImpl* id) const
96 {
97     ASSERT(id);
98     return m_elementsById.contains(id);
99 }
100
101 inline bool TreeScope::containsMultipleElementsWithId(const AtomicString& id) const
102 {
103     return m_elementsById.containsMultiple(id.impl());
104 }
105
106 } // namespace WebCore
107
108 #endif // TreeScope_h