cc5d0a58a26b2055aa94ee4b76d5a880cd06413b
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Controllers / CanvasManager.js
1 /*
2  * Copyright (C) 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 WI.CanvasManager = class CanvasManager extends WI.Object
27 {
28     constructor()
29     {
30         super();
31
32         WI.Frame.addEventListener(WI.Frame.Event.MainResourceDidChange, this._mainResourceDidChange, this);
33
34         this._canvasIdentifierMap = new Map;
35
36         if (window.CanvasAgent)
37             CanvasAgent.enable();
38     }
39
40     // Public
41
42     get canvases()
43     {
44         return [...this._canvasIdentifierMap.values()];
45     }
46
47     canvasAdded(canvasPayload)
48     {
49         // Called from WI.CanvasObserver.
50
51         console.assert(!this._canvasIdentifierMap.has(canvasPayload.canvasId), `Canvas already exists with id ${canvasPayload.canvasId}.`);
52
53         let canvas = WI.Canvas.fromPayload(canvasPayload);
54         this._canvasIdentifierMap.set(canvas.identifier, canvas);
55
56         canvas.frame.canvasCollection.add(canvas);
57
58         this.dispatchEventToListeners(WI.CanvasManager.Event.CanvasWasAdded, {canvas});
59     }
60
61     canvasRemoved(canvasIdentifier)
62     {
63         // Called from WI.CanvasObserver.
64
65         let canvas = this._canvasIdentifierMap.take(canvasIdentifier);
66         console.assert(canvas);
67         if (!canvas)
68             return;
69
70         canvas.frame.canvasCollection.remove(canvas);
71
72         this.dispatchEventToListeners(WI.CanvasManager.Event.CanvasWasRemoved, {canvas});
73     }
74
75     canvasMemoryChanged(canvasIdentifier, memoryCost)
76     {
77         // Called from WI.CanvasObserver.
78
79         let canvas = this._canvasIdentifierMap.get(canvasIdentifier);
80         console.assert(canvas);
81         if (!canvas)
82             return;
83
84         canvas.memoryCost = memoryCost;
85     }
86
87     cssCanvasClientNodesChanged(canvasIdentifier)
88     {
89         // Called from WI.CanvasObserver.
90
91         let canvas = this._canvasIdentifierMap.get(canvasIdentifier);
92         console.assert(canvas);
93         if (!canvas)
94             return;
95
96         canvas.cssCanvasClientNodesChanged();
97     }
98
99     recordingFinished(canvasIdentifier, recordingPayload)
100     {
101         // Called from WI.CanvasObserver.
102
103         let canvas = this._canvasIdentifierMap.get(canvasIdentifier);
104         console.assert(canvas);
105         if (!canvas)
106             return;
107
108         let recording = WI.Recording.fromPayload(recordingPayload);
109         recording.source = canvas;
110
111         this.dispatchEventToListeners(WI.CanvasManager.Event.RecordingFinished, {canvas, recording});
112     }
113
114     // Private
115
116     _mainResourceDidChange(event)
117     {
118         console.assert(event.target instanceof WI.Frame);
119         if (!event.target.isMainFrame())
120             return;
121
122         WI.Canvas.resetUniqueDisplayNameNumbers();
123
124         if (this._canvasIdentifierMap.size) {
125             this._canvasIdentifierMap.clear();
126             this.dispatchEventToListeners(WI.CanvasManager.Event.Cleared);
127         }
128     }
129 };
130
131 WI.CanvasManager.Event = {
132     Cleared: "canvas-manager-cleared",
133     CanvasWasAdded: "canvas-manager-canvas-was-added",
134     CanvasWasRemoved: "canvas-manager-canvas-was-removed",
135     RecordingFinished: "canvas-managger-recording-finished",
136 };