blob: e195d7d718f9c121b22620dd8a3db7814ec2ec83 [file] [log] [blame]
/*
* Copyright (C) 1999 Lars Knoll (knoll@kde.org)
* (C) 1999 Antti Koivisto (koivisto@kde.org)
* Copyright (C) 2004-2019 Apple Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#pragma once
#include "HTMLFrameOwnerElement.h"
#include "Image.h"
#include "JSValueInWrappedObject.h"
#include "RenderEmbeddedObject.h"
namespace JSC {
namespace Bindings {
class Instance;
}
}
namespace WebCore {
class RenderWidget;
class Widget;
class HTMLPlugInElement : public HTMLFrameOwnerElement {
WTF_MAKE_ISO_ALLOCATED(HTMLPlugInElement);
public:
virtual ~HTMLPlugInElement();
void resetInstance();
JSC::Bindings::Instance* bindingsInstance();
enum class PluginLoadingPolicy { DoNotLoad, Load };
WEBCORE_EXPORT Widget* pluginWidget(PluginLoadingPolicy = PluginLoadingPolicy::Load) const;
enum DisplayState {
Playing,
PreparingPluginReplacement,
DisplayingPluginReplacement,
};
DisplayState displayState() const { return m_displayState; }
void setDisplayState(DisplayState);
bool isCapturingMouseEvents() const { return m_isCapturingMouseEvents; }
void setIsCapturingMouseEvents(bool capturing) { m_isCapturingMouseEvents = capturing; }
#if PLATFORM(IOS_FAMILY)
bool willRespondToMouseMoveEvents() final { return false; }
#endif
bool willRespondToMouseClickEvents() final;
virtual bool isPlugInImageElement() const = 0;
bool isUserObservable() const;
WEBCORE_EXPORT bool isBelowSizeThreshold() const;
// Return whether or not the replacement content for blocked plugins is accessible to the user.
WEBCORE_EXPORT bool setReplacement(RenderEmbeddedObject::PluginUnavailabilityReason, const String& unavailabilityDescription);
WEBCORE_EXPORT bool isReplacementObscured();
protected:
HTMLPlugInElement(const QualifiedName& tagName, Document&);
bool canContainRangeEndPoint() const override { return false; }
void willDetachRenderers() override;
bool hasPresentationalHintsForAttribute(const QualifiedName&) const override;
void collectPresentationalHintsForAttribute(const QualifiedName&, const AtomString&, MutableStyleProperties&) override;
virtual bool useFallbackContent() const { return false; }
void defaultEventHandler(Event&) final;
virtual bool requestObject(const String& url, const String& mimeType, const Vector<String>& paramNames, const Vector<String>& paramValues);
RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
void didAddUserAgentShadowRoot(ShadowRoot&) final;
// Subclasses should use guardedDispatchBeforeLoadEvent instead of calling dispatchBeforeLoadEvent directly.
bool guardedDispatchBeforeLoadEvent(const String& sourceURL);
// This will load the plugin if necessary.
virtual RenderWidget* renderWidgetLoadingPlugin() const;
private:
void swapRendererTimerFired();
bool shouldOverridePlugin(const String& url, const String& mimeType);
bool dispatchBeforeLoadEvent(const String& sourceURL) = delete; // Generate a compile error if someone calls this by mistake.
bool supportsFocus() const final;
bool isKeyboardFocusable(KeyboardEvent*) const final;
bool isPluginElement() const final;
bool canLoadScriptURL(const URL&) const final;
RefPtr<JSC::Bindings::Instance> m_instance;
Timer m_swapRendererTimer;
bool m_isCapturingMouseEvents { false };
bool m_inBeforeLoadEventHandler { false };
DisplayState m_displayState { Playing };
};
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::HTMLPlugInElement)
static bool isType(const WebCore::Node& node) { return node.isPluginElement(); }
SPECIALIZE_TYPE_TRAITS_END()