DOM event handling should pass Event around by reference.
[WebKit-https.git] / Source / WebCore / html / HTMLPlugInElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2004, 2006, 2007, 2008, 2009, 2012 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef HTMLPlugInElement_h
24 #define HTMLPlugInElement_h
25
26 #include "HTMLFrameOwnerElement.h"
27 #include "Image.h"
28
29 namespace JSC {
30 namespace Bindings {
31 class Instance;
32 }
33 }
34
35 namespace WebCore {
36
37 class PluginReplacement;
38 class RenderEmbeddedObject;
39 class RenderWidget;
40 class Widget;
41
42 class HTMLPlugInElement : public HTMLFrameOwnerElement {
43 public:
44     virtual ~HTMLPlugInElement();
45
46     void resetInstance();
47
48     PassRefPtr<JSC::Bindings::Instance> getInstance();
49
50     enum class PluginLoadingPolicy { DoNotLoad, Load };
51     WEBCORE_EXPORT Widget* pluginWidget(PluginLoadingPolicy = PluginLoadingPolicy::Load) const;
52
53     enum DisplayState {
54         WaitingForSnapshot,
55         DisplayingSnapshot,
56         Restarting,
57         RestartingWithPendingMouseClick,
58         Playing,
59         PreparingPluginReplacement,
60         DisplayingPluginReplacement,
61     };
62     DisplayState displayState() const { return m_displayState; }
63     virtual void setDisplayState(DisplayState);
64     virtual void updateSnapshot(PassRefPtr<Image>) { }
65     virtual void dispatchPendingMouseClick() { }
66     virtual bool isRestartedPlugin() const { return false; }
67
68     JSC::JSObject* scriptObjectForPluginReplacement();
69
70     bool isCapturingMouseEvents() const { return m_isCapturingMouseEvents; }
71     void setIsCapturingMouseEvents(bool capturing) { m_isCapturingMouseEvents = capturing; }
72
73     bool canContainRangeEndPoint() const override { return false; }
74
75     bool canProcessDrag() const;
76
77 #if PLATFORM(IOS)
78     bool willRespondToMouseMoveEvents() override { return false; }
79 #endif
80     bool willRespondToMouseClickEvents() override;
81
82     virtual bool isPlugInImageElement() const { return false; }
83
84     bool isUserObservable() const;
85     
86 protected:
87     HTMLPlugInElement(const QualifiedName& tagName, Document&);
88
89     void willDetachRenderers() override;
90     bool isPresentationAttribute(const QualifiedName&) const override;
91     void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStyleProperties&) override;
92
93     virtual bool useFallbackContent() const { return false; }
94
95     void defaultEventHandler(Event&) override;
96
97     virtual bool requestObject(const String& url, const String& mimeType, const Vector<String>& paramNames, const Vector<String>& paramValues);
98     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
99     void didAddUserAgentShadowRoot(ShadowRoot*) override;
100
101     // Subclasses should use guardedDispatchBeforeLoadEvent instead of calling dispatchBeforeLoadEvent directly.
102     bool guardedDispatchBeforeLoadEvent(const String& sourceURL);
103
104     bool m_inBeforeLoadEventHandler;
105
106 private:
107     void swapRendererTimerFired();
108     bool shouldOverridePlugin(const String& url, const String& mimeType);
109
110     bool dispatchBeforeLoadEvent(const String& sourceURL); // Not implemented, generates a compile error if subclasses call this by mistake.
111
112     // This will load the plugin if necessary.
113     virtual RenderWidget* renderWidgetLoadingPlugin() const = 0;
114
115     bool supportsFocus() const override;
116
117     bool isKeyboardFocusable(KeyboardEvent&) const override;
118     bool isPluginElement() const final;
119
120     RefPtr<JSC::Bindings::Instance> m_instance;
121     Timer m_swapRendererTimer;
122     RefPtr<PluginReplacement> m_pluginReplacement;
123     bool m_isCapturingMouseEvents;
124
125     DisplayState m_displayState;
126 };
127
128 } // namespace WebCore
129
130 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::HTMLPlugInElement)
131     static bool isType(const WebCore::Node& node) { return node.isPluginElement(); }
132 SPECIALIZE_TYPE_TRAITS_END()
133
134 #endif // HTMLPlugInElement_h