CTTE Timer and DeferrableOneShotTimer
[WebKit-https.git] / Source / WebCore / html / HTMLPlugInImageElement.h
1 /*
2  * Copyright (C) 2008, 2009, 2011, 2012 Apple Inc. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #ifndef HTMLPlugInImageElement_h
22 #define HTMLPlugInImageElement_h
23
24 #include "HTMLPlugInElement.h"
25
26 #include "RenderStyle.h"
27 #include <wtf/OwnPtr.h>
28
29 namespace WebCore {
30
31 class HTMLImageLoader;
32 class HTMLVideoElement;
33 class FrameLoader;
34 class Image;
35 class MouseEvent;
36 class Widget;
37
38 enum PluginCreationOption {
39     CreateAnyWidgetType,
40     CreateOnlyNonNetscapePlugins,
41 };
42
43 enum PreferPlugInsForImagesOption {
44     ShouldPreferPlugInsForImages,
45     ShouldNotPreferPlugInsForImages
46 };
47
48 // Base class for HTMLObjectElement and HTMLEmbedElement
49 class HTMLPlugInImageElement : public HTMLPlugInElement {
50 public:
51     virtual ~HTMLPlugInImageElement();
52
53     RenderEmbeddedObject* renderEmbeddedObject() const;
54
55     virtual void setDisplayState(DisplayState) OVERRIDE;
56
57     virtual void updateWidget(PluginCreationOption) = 0;
58
59     const String& serviceType() const { return m_serviceType; }
60     const String& url() const { return m_url; }
61     const URL& loadedUrl() const { return m_loadedUrl; }
62
63     const String loadedMimeType() const
64     {
65         String mimeType = serviceType();
66         if (mimeType.isEmpty())
67             mimeType = mimeTypeFromURL(m_loadedUrl);
68         return mimeType;
69     }
70
71     bool shouldPreferPlugInsForImages() const { return m_shouldPreferPlugInsForImages; }
72
73     // Public for FrameView::addWidgetToUpdate()
74     bool needsWidgetUpdate() const { return m_needsWidgetUpdate; }
75     void setNeedsWidgetUpdate(bool needsWidgetUpdate) { m_needsWidgetUpdate = needsWidgetUpdate; }
76     
77 #if PLATFORM(IOS)
78     void createShadowIFrameSubtree(const String& src);
79 #endif
80
81     void userDidClickSnapshot(PassRefPtr<MouseEvent>, bool forwardEvent);
82     void checkSnapshotStatus();
83     Image* snapshotImage() const { return m_snapshotImage.get(); }
84     void restartSnapshottedPlugIn();
85
86     // Plug-in URL might not be the same as url() with overriding parameters.
87     void subframeLoaderWillCreatePlugIn(const URL& plugInURL);
88     void subframeLoaderDidCreatePlugIn(const Widget*);
89
90     void setIsPrimarySnapshottedPlugIn(bool);
91     bool partOfSnapshotOverlay(Node*);
92
93     bool needsCheckForSizeChange() const { return m_needsCheckForSizeChange; }
94     void setNeedsCheckForSizeChange() { m_needsCheckForSizeChange = true; }
95     void checkSizeChangeForSnapshotting();
96
97     enum SnapshotDecision {
98         SnapshotNotYetDecided,
99         NeverSnapshot,
100         Snapshotted,
101         MaySnapshotWhenResized,
102         MaySnapshotWhenContentIsSet
103     };
104     SnapshotDecision snapshotDecision() const { return m_snapshotDecision; }
105
106 protected:
107     HTMLPlugInImageElement(const QualifiedName& tagName, Document&, bool createdByParser, PreferPlugInsForImagesOption);
108
109     bool isImageType();
110
111     OwnPtr<HTMLImageLoader> m_imageLoader;
112     String m_serviceType;
113     String m_url;
114     URL m_loadedUrl;
115
116     static void updateWidgetCallback(Node&, unsigned);
117     static void startLoadingImageCallback(Node&, unsigned);
118
119     virtual void didAttachRenderers() OVERRIDE;
120     virtual void willDetachRenderers() OVERRIDE;
121
122     bool allowedToLoadFrameURL(const String& url);
123     bool wouldLoadAsNetscapePlugin(const String& url, const String& serviceType);
124
125     virtual void didMoveToNewDocument(Document* oldDocument) OVERRIDE;
126
127     virtual void documentWillSuspendForPageCache() OVERRIDE;
128     virtual void documentDidResumeFromPageCache() OVERRIDE;
129
130     virtual bool isRestartedPlugin() const OVERRIDE { return m_isRestartedPlugin; }
131     virtual bool requestObject(const String& url, const String& mimeType, const Vector<String>& paramNames, const Vector<String>& paramValues) OVERRIDE;
132
133 private:
134     virtual RenderPtr<RenderElement> createElementRenderer(PassRef<RenderStyle>) OVERRIDE;
135     virtual bool willRecalcStyle(Style::Change) OVERRIDE;
136
137     virtual void didAddUserAgentShadowRoot(ShadowRoot*) OVERRIDE;
138
139     virtual void finishParsingChildren() OVERRIDE;
140
141     void updateWidgetIfNecessary();
142     void startLoadingImage();
143
144     virtual void updateSnapshot(PassRefPtr<Image>) OVERRIDE;
145     virtual void dispatchPendingMouseClick() OVERRIDE;
146     void simulatedMouseClickTimerFired(DeferrableOneShotTimer<HTMLPlugInImageElement>&);
147
148     void restartSimilarPlugIns();
149
150     virtual bool isPlugInImageElement() const OVERRIDE { return true; }
151
152     void removeSnapshotTimerFired(Timer<HTMLPlugInImageElement>&);
153
154     virtual void defaultEventHandler(Event*) OVERRIDE;
155
156     bool m_needsWidgetUpdate;
157     bool m_shouldPreferPlugInsForImages;
158     bool m_needsDocumentActivationCallbacks;
159     RefPtr<MouseEvent> m_pendingClickEventFromSnapshot;
160     DeferrableOneShotTimer<HTMLPlugInImageElement> m_simulatedMouseClickTimer;
161     Timer<HTMLPlugInImageElement> m_removeSnapshotTimer;
162     RefPtr<Image> m_snapshotImage;
163     bool m_createdDuringUserGesture;
164     bool m_isRestartedPlugin;
165     bool m_needsCheckForSizeChange;
166     bool m_plugInWasCreated;
167     bool m_deferredPromotionToPrimaryPlugIn;
168     IntSize m_sizeWhenSnapshotted;
169     SnapshotDecision m_snapshotDecision;
170 };
171
172 void isHTMLPlugInImageElement(const HTMLPlugInImageElement&); // Catch unnecessary runtime check of type known at compile time.
173 inline bool isHTMLPlugInImageElement(const HTMLPlugInElement& element) { return element.isPlugInImageElement(); }
174 inline bool isHTMLPlugInImageElement(const Node& node) { return node.isPluginElement() && toHTMLPlugInElement(node).isPlugInImageElement(); }
175 NODE_TYPE_CASTS(HTMLPlugInImageElement)
176
177 } // namespace WebCore
178
179 #endif // HTMLPlugInImageElement_h