c00c1330bbe883addc61361ef4e09e35ce1d1285
[WebKit-https.git] / WebCore / inspector / InspectorDOMAgent.h
1 /*
2  * Copyright (C) 2009 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef InspectorDOMAgent_h
31 #define InspectorDOMAgent_h
32
33 #include "AtomicString.h"
34 #include "Document.h"
35 #include "EventListener.h"
36 #include "EventTarget.h"
37 #include "InspectorCSSStore.h"
38 #include "InspectorValues.h"
39 #include "NodeList.h"
40 #include "ScriptState.h"
41 #include "Timer.h"
42
43 #include <wtf/Deque.h>
44 #include <wtf/ListHashSet.h>
45 #include <wtf/HashMap.h>
46 #include <wtf/HashSet.h>
47 #include <wtf/PassRefPtr.h>
48 #include <wtf/RefPtr.h>
49
50 namespace WebCore {
51     class ContainerNode;
52     class CSSRule;
53     class CSSRuleList;
54     class CSSStyleDeclaration;
55     class CSSStyleRule;
56     class CSSStyleSheet;
57     class Element;
58     class Event;
59     class InspectorFrontend2;
60     class MatchJob;
61     class NameNodeMap;
62     class Node;
63     class Page;
64
65     struct EventListenerInfo {
66         EventListenerInfo(Node* node, const AtomicString& eventType, const EventListenerVector& eventListenerVector)
67             : node(node)
68             , eventType(eventType)
69             , eventListenerVector(eventListenerVector)
70         {
71         }
72
73         Node* node;
74         const AtomicString eventType;
75         const EventListenerVector eventListenerVector;
76     };
77
78     class InspectorDOMAgent : public EventListener {
79     public:
80         static PassRefPtr<InspectorDOMAgent> create(InspectorCSSStore* cssStore, InspectorFrontend2* frontend)
81         {
82             return adoptRef(new InspectorDOMAgent(cssStore, frontend));
83         }
84
85         static const InspectorDOMAgent* cast(const EventListener* listener)
86         {
87             return listener->type() == InspectorDOMAgentType
88                 ? static_cast<const InspectorDOMAgent*>(listener)
89                 : 0;
90         }
91
92         InspectorDOMAgent(InspectorCSSStore* cssStore, InspectorFrontend2* frontend);
93         ~InspectorDOMAgent();
94
95         void reset();
96
97         virtual bool operator==(const EventListener& other);
98
99         // Methods called from the frontend for DOM nodes inspection.
100         void getChildNodes(long callId, long nodeId);
101         void setAttribute(long callId, long elementId, const String& name, const String& value);
102         void removeAttribute(long callId, long elementId, const String& name);
103         void removeNode(long callId, long nodeId);
104         void changeTagName(long callId, long nodeId, const String& tagName);
105         void getOuterHTML(long callId, long nodeId);
106         void setOuterHTML(long callId, long nodeId, const String& outerHTML);
107         void setTextNodeValue(long callId, long nodeId, const String& value);
108         void getEventListenersForNode(long callId, long nodeId);
109         void addInspectedNode(long nodeId);
110         void performSearch(const String& whitespaceTrimmedQuery, bool runSynchronously);
111         void searchCanceled();
112
113         // Methods called from the frontend for CSS styles inspection.
114         void getStyles(long callId, long nodeId, bool authorOnly);
115         void getAllStyles(long callId);
116         void getInlineStyle(long callId, long nodeId);
117         void getComputedStyle(long callId, long nodeId);
118         void getStyleSheet(long callId, long styleSheetId);
119         void getRuleRangesForStyleSheetId(long callId, long styleSheetId);
120         void applyStyleText(long callId, long styleId, const String& styleText, const String& propertyName);
121         void setStyleText(long callId, long styleId, const String& cssText);
122         void setStyleProperty(long callId, long styleId, const String& name, const String& value);
123         void toggleStyleEnabled(long callId, long styleId, const String& propertyName, bool disabled);
124         void setRuleSelector(long callId, long ruleId, const String& selector, long selectedNodeId);
125         void addRule(long callId, const String& selector, long selectedNodeId);
126
127         // Methods called from the InspectorController.
128         void setDocument(Document* document);
129         void releaseDanglingNodes();
130
131         void didInsertDOMNode(Node*);
132         void didRemoveDOMNode(Node*);
133         void didModifyDOMAttr(Element*);
134
135         Node* nodeForId(long nodeId);
136         long pushNodePathToFrontend(Node* node);
137         void pushChildNodesToFrontend(long nodeId);
138         long pushNodeByPathToFrontend(const String& path);
139         long inspectedNode(unsigned long num);
140
141     private:
142         static CSSStyleSheet* getParentStyleSheet(CSSStyleDeclaration*);
143         void startListening(Document* document);
144         void stopListening(Document* document);
145
146         virtual void handleEvent(ScriptExecutionContext*, Event* event);
147
148         // Node-related methods.
149         typedef HashMap<RefPtr<Node>, long> NodeToIdMap;
150         long bind(Node* node, NodeToIdMap* nodesMap);
151         void unbind(Node* node, NodeToIdMap* nodesMap);
152
153         bool pushDocumentToFrontend();
154
155         PassRefPtr<InspectorObject> buildObjectForAttributeStyles(Element* element);
156         PassRefPtr<InspectorArray> buildArrayForCSSRules(Document* ownerDocument, CSSRuleList*);
157         PassRefPtr<InspectorArray> buildArrayForPseudoElements(Element* element, bool authorOnly);
158
159         PassRefPtr<InspectorObject> buildObjectForNode(Node* node, int depth, NodeToIdMap* nodesMap);
160         PassRefPtr<InspectorArray> buildArrayForElementAttributes(Element* element);
161         PassRefPtr<InspectorArray> buildArrayForContainerChildren(Node* container, int depth, NodeToIdMap* nodesMap);
162         PassRefPtr<InspectorObject> buildObjectForEventListener(const RegisteredEventListener& registeredEventListener, const AtomicString& eventType, Node* node);
163
164         // We represent embedded doms as a part of the same hierarchy. Hence we treat children of frame owners differently.
165         // We also skip whitespace text nodes conditionally. Following methods encapsulate these specifics.
166         Node* innerFirstChild(Node* node);
167         Node* innerNextSibling(Node* node);
168         Node* innerPreviousSibling(Node* node);
169         unsigned innerChildNodeCount(Node* node);
170         Node* innerParentNode(Node* node);
171         bool isWhitespace(Node* node);
172
173         Document* mainFrameDocument() const;
174         String documentURLString(Document* document) const;
175         InspectorCSSStore* cssStore() { return m_cssStore; }
176
177         void onMatchJobsTimer(Timer<InspectorDOMAgent>*);
178         void reportNodesAsSearchResults(ListHashSet<Node*>& resultCollector);
179
180         PassRefPtr<InspectorObject> buildObjectForStyle(CSSStyleDeclaration*, bool bind);
181         void populateObjectWithStyleProperties(CSSStyleDeclaration*, InspectorObject* result);
182         PassRefPtr<InspectorArray> buildArrayForDisabledStyleProperties(DisabledStyleDeclaration*);
183         PassRefPtr<InspectorObject> buildObjectForRule(Document* ownerDocument, CSSStyleRule*);
184         PassRefPtr<InspectorObject> buildObjectForStyleSheet(Document* ownerDocument, CSSStyleSheet*);
185         Vector<String> longhandProperties(CSSStyleDeclaration*, const String& shorthandProperty);
186         String shorthandValue(CSSStyleDeclaration*, const String& shorthandProperty);
187         String shorthandPriority(CSSStyleDeclaration*, const String& shorthandProperty);
188         bool ruleAffectsNode(CSSStyleRule*, Node*);
189         Node* nodeForPath(const String& path);
190         PassRefPtr<InspectorArray> toArray(const Vector<String>& data);
191
192         void discardBindings();
193
194         InspectorCSSStore* m_cssStore;
195         InspectorFrontend2* m_frontend;
196         NodeToIdMap m_documentNodeToIdMap;
197         // Owns node mappings for dangling nodes.
198         Vector<NodeToIdMap*> m_danglingNodeToIdMaps;
199         HashMap<long, Node*> m_idToNode;
200         HashMap<long, NodeToIdMap*> m_idToNodesMap;
201         HashSet<long> m_childrenRequested;
202         long m_lastNodeId;
203         ListHashSet<RefPtr<Document> > m_documents;
204         Deque<MatchJob*> m_pendingMatchJobs;
205         Timer<InspectorDOMAgent> m_matchJobsTimer;
206         HashSet<RefPtr<Node> > m_searchResults;
207         Vector<long> m_inspectedNodes;
208     };
209
210 } // namespace WebCore
211
212 #endif // !defined(InspectorDOMAgent_h)