Add a base class for HTMLCanvasElement and OffscreenCanvas
[WebKit-https.git] / Source / WebCore / html / canvas / CanvasRenderingContext.h
1 /*
2  * Copyright (C) 2009, 2017 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 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 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 #pragma once
27
28 #include "GraphicsLayer.h"
29 #include "HTMLCanvasElement.h"
30 #include "ScriptWrappable.h"
31 #include <wtf/Noncopyable.h>
32 #include <wtf/text/StringHash.h>
33
34 namespace WebCore {
35
36 class CanvasPattern;
37 class HTMLCanvasElement;
38 class HTMLImageElement;
39 class HTMLVideoElement;
40 class ImageBitmap;
41 class URL;
42 class WebGLObject;
43
44 class CanvasRenderingContext : public ScriptWrappable {
45     WTF_MAKE_NONCOPYABLE(CanvasRenderingContext); WTF_MAKE_FAST_ALLOCATED;
46 public:
47     virtual ~CanvasRenderingContext() = default;
48
49     void ref();
50     void deref();
51
52     CanvasBase& canvasBase() const { return m_canvas; }
53
54     virtual bool is2d() const { return false; }
55     virtual bool isWebGL1() const { return false; }
56     virtual bool isWebGL2() const { return false; }
57     bool isWebGL() const { return isWebGL1() || isWebGL2(); }
58 #if ENABLE(WEBGPU)
59     virtual bool isWebGPU() const { return false; }
60 #endif
61     virtual bool isGPUBased() const { return false; }
62     virtual bool isAccelerated() const { return false; }
63     virtual bool isBitmapRenderer() const { return false; }
64     virtual bool isPlaceholder() const { return false; }
65
66     virtual void paintRenderingResultsToCanvas() {}
67     virtual PlatformLayer* platformLayer() const { return 0; }
68
69     bool callTracingActive() const { return m_callTracingActive; }
70     void setCallTracingActive(bool callTracingActive) { m_callTracingActive = callTracingActive; }
71
72 protected:
73     explicit CanvasRenderingContext(CanvasBase&);
74     bool wouldTaintOrigin(const CanvasPattern*);
75     bool wouldTaintOrigin(const HTMLCanvasElement*);
76     bool wouldTaintOrigin(const HTMLImageElement*);
77     bool wouldTaintOrigin(const HTMLVideoElement*);
78     bool wouldTaintOrigin(const ImageBitmap*);
79     bool wouldTaintOrigin(const URL&);
80
81     template<class T> void checkOrigin(const T* arg)
82     {
83         if (wouldTaintOrigin(arg))
84             m_canvas.setOriginTainted();
85     }
86     void checkOrigin(const URL&);
87
88     bool m_callTracingActive { false };
89
90 private:
91     CanvasBase& m_canvas;
92 };
93
94 } // namespace WebCore
95
96 #define SPECIALIZE_TYPE_TRAITS_CANVASRENDERINGCONTEXT(ToValueTypeName, predicate) \
97 SPECIALIZE_TYPE_TRAITS_BEGIN(ToValueTypeName) \
98     static bool isType(const WebCore::CanvasRenderingContext& context) { return context.predicate; } \
99 SPECIALIZE_TYPE_TRAITS_END()