Element's renderer factory should return RenderPtrs.
[WebKit-https.git] / Source / WebCore / Modules / plugins / PluginReplacement.h
1 /*
2  * Copyright (C) 2013 Apple 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef PluginReplacement_h
27 #define PluginReplacement_h
28
29 #include "RenderPtr.h"
30 #include <wtf/RefCounted.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace JSC {
34 class JSObject;
35 }
36
37 namespace WebCore {
38
39 class HTMLPlugInElement;
40 class RenderElement;
41 class RenderStyle;
42 class ShadowRoot;
43
44 class PluginReplacement : public RefCounted<PluginReplacement> {
45 public:
46     virtual ~PluginReplacement() { }
47
48     virtual bool installReplacement(ShadowRoot*) = 0;
49     virtual JSC::JSObject* scriptObject() { return 0; }
50
51     virtual bool willCreateRenderer() { return false; }
52     virtual RenderPtr<RenderElement> createElementRenderer(HTMLPlugInElement&, PassRef<RenderStyle>) = 0;
53
54 protected:
55     PluginReplacement() { }
56 };
57
58 typedef PassRefPtr<PluginReplacement> (*CreatePluginReplacement)(HTMLPlugInElement&, const Vector<String>& paramNames, const Vector<String>& paramValues);
59 typedef bool (*PluginReplacementSupportsType)(const String&);
60 typedef bool (*PluginReplacementSupportsFileExtension)(const String&);
61
62 class ReplacementPlugin {
63 public:
64     ReplacementPlugin(CreatePluginReplacement constructor, PluginReplacementSupportsType supportsType, PluginReplacementSupportsFileExtension supportsFileExtension)
65         : m_constructor(constructor)
66         , m_supportsType(supportsType)
67         , m_supportsFileExtension(supportsFileExtension)
68     {
69     }
70
71     explicit ReplacementPlugin(const ReplacementPlugin& other)
72         : m_constructor(other.m_constructor)
73         , m_supportsType(other.m_supportsType)
74         , m_supportsFileExtension(other.m_supportsFileExtension)
75     {
76     }
77
78     PassRefPtr<PluginReplacement> create(HTMLPlugInElement& element, const Vector<String>& paramNames, const Vector<String>& paramValues) const { return m_constructor(element, paramNames, paramValues); }
79     bool supportsType(const String& mimeType) const { return m_supportsType(mimeType); }
80     bool supportsFileExtension(const String& extension) const { return m_supportsFileExtension(extension); }
81
82 private:
83     CreatePluginReplacement m_constructor;
84     PluginReplacementSupportsType m_supportsType;
85     PluginReplacementSupportsFileExtension m_supportsFileExtension;
86 };
87
88 typedef void (*PluginReplacementRegistrar)(const ReplacementPlugin&);
89
90 }
91
92 #endif