Relanding(r111754): HTMLPluginElement is not destroyed on reload or navigation if...
[WebKit-https.git] / Source / WebCore / testing / Internals.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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef Internals_h
27 #define Internals_h
28
29 #include "FrameDestructionObserver.h"
30 #include "NodeList.h"
31 #include "PlatformString.h"
32 #include <wtf/PassRefPtr.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37
38 class ClientRect;
39 class ClientRectList;
40 class Document;
41 class DocumentMarker;
42 class Element;
43 class InternalSettings;
44 class Node;
45 class Range;
46 class ShadowRoot;
47 class WebKitPoint;
48
49 typedef int ExceptionCode;
50
51 class Internals : public RefCounted<Internals>,
52                   public FrameDestructionObserver {
53 public:
54     static PassRefPtr<Internals> create(Document*);
55     virtual ~Internals();
56
57     void reset(Document*);
58
59     String elementRenderTreeAsText(Element*, ExceptionCode&);
60
61     String address(Node*);
62
63     bool isPreloaded(Document*, const String& url);
64
65     size_t numberOfScopedHTMLStyleChildren(const Node*, ExceptionCode&) const;
66
67 #if ENABLE(SHADOW_DOM)
68     typedef ShadowRoot ShadowRootIfShadowDOMEnabledOrNode;
69 #else
70     typedef Node ShadowRootIfShadowDOMEnabledOrNode;
71 #endif
72     ShadowRootIfShadowDOMEnabledOrNode* ensureShadowRoot(Element* host, ExceptionCode&);
73     ShadowRootIfShadowDOMEnabledOrNode* shadowRoot(Element* host, ExceptionCode&);
74     ShadowRootIfShadowDOMEnabledOrNode* youngestShadowRoot(Element* host, ExceptionCode&);
75     ShadowRootIfShadowDOMEnabledOrNode* oldestShadowRoot(Element* host, ExceptionCode&);
76     ShadowRootIfShadowDOMEnabledOrNode* youngerShadowRoot(Node* shadow, ExceptionCode&);
77     ShadowRootIfShadowDOMEnabledOrNode* olderShadowRoot(Node* shadow, ExceptionCode&);
78     void removeShadowRoot(Element* host, ExceptionCode&);
79     Element* includerFor(Node*, ExceptionCode&);
80     String shadowPseudoId(Element*, ExceptionCode&);
81     PassRefPtr<Element> createContentElement(Document*, ExceptionCode&);
82     Element* getElementByIdInShadowRoot(Node* shadowRoot, const String& id, ExceptionCode&);
83     bool isValidContentSelect(Element* insertionPoint, ExceptionCode&);
84
85     bool attached(Node*, ExceptionCode&);
86
87 #if ENABLE(INPUT_COLOR)
88     void selectColorInColorChooser(Element*, const String& colorValue);
89 #endif
90
91     PassRefPtr<ClientRect> boundingBox(Element*, ExceptionCode&);
92
93     PassRefPtr<ClientRectList> inspectorHighlightRects(Document*, ExceptionCode&);
94
95     unsigned markerCountForNode(Node*, const String&, ExceptionCode&);
96     PassRefPtr<Range> markerRangeForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
97     String markerDescriptionForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
98
99     void setScrollViewPosition(Document*, long x, long y, ExceptionCode&);
100
101     void setPagination(Document*, const String& mode, int gap, ExceptionCode&);
102
103     bool wasLastChangeUserEdit(Element* textField, ExceptionCode&);
104     String suggestedValue(Element* inputElement, ExceptionCode&);
105     void setSuggestedValue(Element* inputElement, const String&, ExceptionCode&);
106     void scrollElementToRect(Element*, long x, long y, long w, long h, ExceptionCode&);
107
108     void paintControlTints(Document*, ExceptionCode&);
109
110     PassRefPtr<Range> rangeFromLocationAndLength(Element* scope, int rangeLocation, int rangeLength, ExceptionCode&);
111     unsigned locationFromRange(Element* scope, const Range*, ExceptionCode&);
112     unsigned lengthFromRange(Element* scope, const Range*, ExceptionCode&);
113     String rangeAsText(const Range*, ExceptionCode&);
114
115 #if ENABLE(TOUCH_ADJUSTMENT)
116     PassRefPtr<WebKitPoint> touchPositionAdjustedToBestClickableNode(long x, long y, long width, long height, Document*, ExceptionCode&);
117     Node* touchNodeAdjustedToBestClickableNode(long x, long y, long width, long height, Document*, ExceptionCode&);
118 #endif
119
120     int lastSpellCheckRequestSequence(Document*, ExceptionCode&);
121     int lastSpellCheckProcessedSequence(Document*, ExceptionCode&);
122     
123     void setMediaPlaybackRequiresUserGesture(Document*, bool enabled, ExceptionCode&);
124
125     Vector<String> userPreferredLanguages() const;
126     void setUserPreferredLanguages(const Vector<String>&);
127
128     void setShouldDisplayTrackKind(Document*, const String& kind, bool, ExceptionCode&);
129     bool shouldDisplayTrackKind(Document*, const String& kind, ExceptionCode&);
130
131     unsigned wheelEventHandlerCount(Document*, ExceptionCode&);
132     unsigned touchEventHandlerCount(Document*, ExceptionCode&);
133
134     PassRefPtr<NodeList> nodesFromRect(Document*, int x, int y, unsigned topPadding, unsigned rightPadding,
135         unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, ExceptionCode&) const;
136
137     void emitInspectorDidBeginFrame();
138     void emitInspectorDidCancelFrame();
139
140     bool hasSpellingMarker(Document*, int from, int length, ExceptionCode&);
141     bool hasGrammarMarker(Document*, int from, int length, ExceptionCode&);
142
143     static const char* internalsId;
144
145     InternalSettings* settings() const { return m_settings.get(); }
146
147     void setBatteryStatus(Document*, const String& eventType, bool charging, double chargingTime, double dischargingTime, double level, ExceptionCode&);
148
149 #if ENABLE(INSPECTOR)
150     unsigned numberOfLiveNodes() const;
151     unsigned numberOfLiveDocuments() const;
152 #endif
153
154 private:
155     explicit Internals(Document*);
156     DocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
157
158     RefPtr<InternalSettings> m_settings;
159 };
160
161 } // namespace WebCore
162
163 #endif