bdf87b9b6137d859f8601400a109b41de560a433
[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 #include <wtf/RefPtr.h>
29
30 namespace WebCore {
31
32 class HTMLImageLoader;
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 KURL& 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     void userDidClickSnapshot(PassRefPtr<MouseEvent>, bool forwardEvent);
78     void updateSnapshotInfo();
79     Image* snapshotImage() const { return m_snapshotImage.get(); }
80
81     // Plug-in URL might not be the same as url() with overriding parameters.
82     void subframeLoaderWillCreatePlugIn(const KURL& plugInURL);
83     void subframeLoaderDidCreatePlugIn(const Widget*);
84
85     void setIsPrimarySnapshottedPlugIn(bool);
86     bool partOfSnapshotLabel(Node*);
87
88 protected:
89     HTMLPlugInImageElement(const QualifiedName& tagName, Document*, bool createdByParser, PreferPlugInsForImagesOption);
90
91     bool isImageType();
92
93     OwnPtr<HTMLImageLoader> m_imageLoader;
94     String m_serviceType;
95     String m_url;
96     KURL m_loadedUrl;
97
98     static void updateWidgetCallback(Node*, unsigned = 0);
99     virtual void attach();
100     virtual void detach();
101
102     bool allowedToLoadFrameURL(const String& url);
103     bool wouldLoadAsNetscapePlugin(const String& url, const String& serviceType);
104
105     virtual void didMoveToNewDocument(Document* oldDocument) OVERRIDE;
106
107     virtual void documentWillSuspendForPageCache() OVERRIDE;
108     virtual void documentDidResumeFromPageCache() OVERRIDE;
109
110     virtual PassRefPtr<RenderStyle> customStyleForRenderer() OVERRIDE;
111
112     void restartSnapshottedPlugIn();
113     virtual bool restartedPlugin() const OVERRIDE { return m_restartedPlugin; }
114
115 private:
116     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
117     virtual bool willRecalcStyle(StyleChange);
118
119     void didAddUserAgentShadowRoot(ShadowRoot*) OVERRIDE;
120
121     virtual void finishParsingChildren();
122
123     void updateWidgetIfNecessary();
124
125     virtual void updateSnapshot(PassRefPtr<Image>) OVERRIDE;
126     virtual void dispatchPendingMouseClick() OVERRIDE;
127     void simulatedMouseClickTimerFired(DeferrableOneShotTimer<HTMLPlugInImageElement>*);
128
129     void swapRendererTimerFired(Timer<HTMLPlugInImageElement>*);
130
131     void restartSimilarPlugIns();
132
133     virtual bool isPlugInImageElement() const OVERRIDE { return true; }
134
135     void removeSnapshotTimerFired(Timer<HTMLPlugInImageElement>*);
136
137     bool m_needsWidgetUpdate;
138     bool m_shouldPreferPlugInsForImages;
139     bool m_needsDocumentActivationCallbacks;
140     RefPtr<RenderStyle> m_customStyleForPageCache;
141     RefPtr<MouseEvent> m_pendingClickEventFromSnapshot;
142     DeferrableOneShotTimer<HTMLPlugInImageElement> m_simulatedMouseClickTimer;
143     Timer<HTMLPlugInImageElement> m_swapRendererTimer;
144     Timer<HTMLPlugInImageElement> m_removeSnapshotTimer;
145     RefPtr<Image> m_snapshotImage;
146     RefPtr<Element> m_shadowContainer;
147     RefPtr<Element> m_snapshotLabel;
148     bool m_createdDuringUserGesture;
149     bool m_restartedPlugin;
150 };
151
152 inline HTMLPlugInImageElement* toHTMLPlugInImageElement(Node* node)
153 {
154     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isPluginElement());
155     HTMLPlugInElement* plugInElement = static_cast<HTMLPlugInElement*>(node);
156     ASSERT_WITH_SECURITY_IMPLICATION(plugInElement->isPlugInImageElement());
157     return static_cast<HTMLPlugInImageElement*>(plugInElement);
158 }
159
160 inline const HTMLPlugInImageElement* toHTMLPlugInImageElement(const Node* node)
161 {
162     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isPluginElement());
163     const HTMLPlugInElement* plugInElement = static_cast<const HTMLPlugInElement*>(node);
164     ASSERT_WITH_SECURITY_IMPLICATION(plugInElement->isPlugInImageElement());
165     return static_cast<const HTMLPlugInImageElement*>(plugInElement);
166 }
167
168 // This will catch anyone doing an unnecessary cast.
169 void toHTMLPlugInImageElement(const HTMLPlugInImageElement*);
170
171 } // namespace WebCore
172
173 #endif // HTMLPlugInImageElement_h