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