[Streams API] Add support for chunks with customized sizes
[WebKit-https.git] / Source / WebCore / bindings / js / ReadableJSStream.h
1 /*
2  * Copyright (C) 2O15 Canon Inc. 2015
3  * Copyright (C) 2015 Igalia S.L. 2015
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted, provided that the following conditions
7  * are required to be met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Canon Inc. nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY CANON INC. AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL CANON INC. AND ITS CONTRIBUTORS BE LIABLE FOR
22  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef ReadableJSStream_h
31 #define ReadableJSStream_h
32
33 #if ENABLE(STREAMS_API)
34
35 #include "ReadableStream.h"
36 #include <heap/Strong.h>
37 #include <heap/StrongInlines.h>
38 #include <runtime/JSCJSValue.h>
39 #include <runtime/PrivateName.h>
40 #include <wtf/Deque.h>
41 #include <wtf/Ref.h>
42
43 namespace JSC {
44 class JSFunction;
45 class JSPromise;
46 }
47     
48 namespace WebCore {
49
50 class JSDOMGlobalObject;
51 class ReadableStreamController;
52
53 typedef int ExceptionCode;
54
55 class ReadableJSStream: public ReadableStream {
56 public:
57     static RefPtr<ReadableJSStream> create(JSC::ExecState&, ScriptExecutionContext&);
58
59     JSC::JSValue jsController(JSC::ExecState&, JSDOMGlobalObject*);
60     void close(ExceptionCode&);
61
62     void storeError(JSC::ExecState&, JSC::JSValue);
63     JSC::JSValue error() override { return m_error.get(); }
64
65     void enqueue(JSC::ExecState&);
66
67     double desiredSize() const { return m_highWaterMark - m_totalQueueSize; }
68
69 private:
70     ReadableJSStream(ScriptExecutionContext&, JSC::ExecState&, JSC::JSObject*, double, JSC::JSFunction*);
71
72     void doStart(JSC::ExecState&);
73
74     JSC::JSPromise* invoke(JSC::ExecState&, const char*, JSC::JSValue parameter);
75     void storeException(JSC::ExecState&);
76
77     virtual bool hasEnoughValues() const override { return desiredSize() <= 0; }
78     virtual bool hasValue() const override;
79     virtual JSC::JSValue read() override;
80     virtual bool doPull() override;
81     virtual bool doCancel(JSC::JSValue) override;
82
83     JSDOMGlobalObject* globalObject();
84
85     double retrieveChunkSize(JSC::ExecState&, JSC::JSValue);
86
87     std::unique_ptr<ReadableStreamController> m_controller;
88     // FIXME: we should consider not using JSC::Strong, see https://bugs.webkit.org/show_bug.cgi?id=146278
89     JSC::Strong<JSC::Unknown> m_error;
90     JSC::Strong<JSC::JSFunction> m_errorFunction;
91     JSC::Strong<JSC::JSObject> m_source;
92
93     struct Chunk {
94         JSC::Strong<JSC::Unknown> value;
95         double size;
96     };
97     Deque<Chunk> m_chunkQueue;
98
99     double m_totalQueueSize { 0 };
100     double m_highWaterMark;
101     JSC::Strong<JSC::JSFunction> m_sizeFunction;
102 };
103
104 } // namespace WebCore
105
106 #endif // ENABLE(STREAMS_API)
107
108 #endif // ReadableJSStream_h