Skip to content

Commit

Permalink
Use new Streams algorithm and mixins
Browse files Browse the repository at this point in the history 
Follows whatwg/streams#1073.
  • Loading branch information
@domenic @annevk
domenic authored and annevk committed Sep 8, 2020
1 parent 46711e6 commit 7995519
Showing 1 changed file with 26 additions and 70 deletions.
96 changes: 26 additions & 70 deletions encoding.bs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1604,29 +1604,6 @@ function convertString(buffer, input, callback) {
</div>


<h3 id=interface-mixin-generictransformstream>Interface mixin {{GenericTransformStream}}</h3>

<p>The {{GenericTransformStream}} interface mixin represents the concept of a
<a>transform stream</a> in IDL. It is not a {{TransformStream}}, though it has the same interface
and it delegates to one.

<pre class=idl>
interface mixin GenericTransformStream {
readonly attribute ReadableStream readable;
readonly attribute WritableStream writable;
};
</pre>

<p>An object that includes {{GenericTransformStream}} has an associated
<dfn for=GenericTransformStream>transform</dfn> of type {{TransformStream}}.

<p>The <dfn attribute for=GenericTransformStream><code>readable</code></dfn> getter steps are to
return <a>this</a>'s <a for=GenericTransformStream>transform</a>.\[[readable]].

<p>The <dfn attribute for=GenericTransformStream><code>writable</code></dfn> getter steps are to
return <a>this</a>'s <a for=GenericTransformStream>transform</a>.\[[writable]].


<h3 id=interface-textdecoderstream>Interface {{TextDecoderStream}}</h3>

<pre class=idl>
Expand Down Expand Up @@ -1706,19 +1683,18 @@ constructor steps are:
<a>this</a>'s <a for=TextDecoderCommon>encoding</a>, and set <a>this</a>'s
<a for=TextDecoderCommon>I/O queue</a> to a new <a for=/>I/O queue</a>.

<li><p>Let <var>startAlgorithm</var> be an algorithm that takes no arguments and returns nothing.

<li><p>Let <var>transformAlgorithm</var> be an algorithm which takes a <var>chunk</var> argument
and runs the <a>decode and enqueue a chunk</a> algorithm with <a>this</a> and <var>chunk</var>.

<li><p>Let <var>flushAlgorithm</var> be an algorithm which takes no arguments and runs the
<a>flush and enqueue</a> algorithm with <a>this</a>.

<li><p>Let <var>transform</var> be the result of calling
<a abstract-op>CreateTransformStream</a>(<var>startAlgorithm</var>, <var>transformAlgorithm</var>,
<var>flushAlgorithm</var>).

<li><p>Set <a>this</a>'s <a for=GenericTransformStream>transform</a> to <var>transform</var>.
<li><p>Set <a>this</a>'s <a for=GenericTransformStream>transform</a> to the result of
<a for=TransformStream>creating</a> a {{TransformStream}} with
<a for=TransformStream/create><var ignore>transformAlgorithm</var></a> set to
<var>transformAlgorithm</var> and
<a for=TransformStream/create><var ignore>flushAlgorithm</var></a> set to
<var>flushAlgorithm</var>.
</ol>

<p>The <dfn>decode and enqueue a chunk</dfn> algorithm, given a {{TextDecoderStream}} object
Expand All @@ -1727,20 +1703,15 @@ constructor steps are:
<ol>
<li><p>Let <var>bufferSource</var> be the result of
<a lt="converted to an IDL value">converting</a> <var>chunk</var> to an
<code>[<a extended-attribute>AllowShared</a>] <a typedef>BufferSource</a></code>. If this throws an
exception, then return a promise rejected with that exception.
<code>[<a extended-attribute>AllowShared</a>] <a typedef>BufferSource</a></code>.

<li>
<p><a>Push</a> a <a lt="get a copy of the buffer source">copy of</a> <var>bufferSource</var> to
<var>decoder</var>'s <a for=TextDecoderCommon>I/O queue</a>. If this throws an exception, then
return a promise rejected with that exception.
<var>decoder</var>'s <a for=TextDecoderCommon>I/O queue</a>.

<p class=warning>See the
<a href=#sharedarraybuffer-warning>warning for <code>SharedArrayBuffer</code> objects</a> above.

<li><p>Let <var>controller</var> be <var>decoder</var>'s
<a for=GenericTransformStream>transform</a>.\[[transformStreamController]].

<li><p>Let <var>output</var> be the <a for=/>I/O queue</a> of scalar values
« <a>end-of-queue</a> ».

Expand All @@ -1758,20 +1729,16 @@ constructor steps are:
<li><p>Let <var>outputChunk</var> be the result of running <a>serialize I/O queue</a> with
<var>decoder</var> and <var>output</var>.

<li><p>if <var>outputChunk</var> is non-empty, call
<a abstract-op>TransformStreamDefaultControllerEnqueue</a>(<var>controller</var>,
<var>outputChunk</var>).

<li><p>Return a new promise resolved with undefined.
<li><p>If <var>outputChunk</var> is non-empty, then <a for=TransformStream>enqueue</a>
<var>outputChunk</var> in <var>decoder</var>'s <a for=GenericTransformStream>transform</a>.
</ol>

<li><p>Let <var>result</var> be the result of <a>processing</a> <var>item</var> for
<var>decoder</var>'s <a for=TextDecoderCommon>decoder</a>, <var>decoder</var>'s
<a for=TextDecoderCommon>I/O queue</a>, <var>output</var>, and <var>decoder</var>'s
<a for=TextDecoderCommon>error mode</a>.

<li><p>If <var>result</var> is <a>error</a>, then return a new promise rejected with a
{{TypeError}} exception.
<li><p>If <var>result</var> is <a>error</a>, then throw a {{TypeError}} exception.
</ol>
</ol>

Expand All @@ -1798,14 +1765,11 @@ steps:
<li><p>Let <var>controller</var> be <var>decoder</var>'s
<a for=GenericTransformStream>transform</a>.\[[transformStreamController]].

<li><p>If <var>outputChunk</var> is non-empty, call
<a abstract-op>TransformStreamDefaultControllerEnqueue</a>(<var>controller</var>,
<var>outputChunk</var>).

<li><p>Return a new promise resolved with undefined.
<li><p>If <var>outputChunk</var> is non-empty, then <a for=TransformStream>enqueue</a>
<var>outputChunk</var> in <var>decoder</var>'s <a for=GenericTransformStream>transform</a>.
</ol>

<li><p>Otherwise, return a new promise rejected with a {{TypeError}} exception.
<li><p>Otherwise, throw a {{TypeError}} exception.
</ol>


Expand Down Expand Up @@ -1876,11 +1840,12 @@ constructor steps are:
<li><p>Let <var>flushAlgorithm</var> be an algorithm which runs the <a>encode and flush</a>
algorithm with <a>this</a>.

<li><p>Let <var>transform</var> be the result of calling
<a abstract-op>CreateTransformStream</a>(<var>startAlgorithm</var>, <var>transformAlgorithm</var>,
<var>flushAlgorithm</var>).

<li><p>Set <a>this</a>'s <a for=GenericTransformStream>transform</a> to <var>transform</var>.
<li><p>Set <a>this</a>'s <a for=GenericTransformStream>transform</a> to the result of
<a for=TransformStream>creating</a> a {{TransformStream}} with
<a for=TransformStream/create><var ignore>transformAlgorithm</var></a> set to
<var>transformAlgorithm</var> and
<a for=TransformStream/create><var ignore>flushAlgorithm</var></a> set to
<var>flushAlgorithm</var>.
</ol>

<hr>
Expand All @@ -1890,8 +1855,7 @@ constructor steps are:

<ol>
<li><p>Let <var>input</var> be the result of <a lt="converted to an IDL value">converting</a>
<var>chunk</var> to a {{DOMString}}. If this throws an exception, then return a promise rejected
with that exception.
<var>chunk</var> to a {{DOMString}}.

<li><p><a for="to I/O queue">Convert</a> <var>input</var> to an <a for=/>I/O queue</a> of
<a>code units</a>.
Expand All @@ -1903,9 +1867,6 @@ constructor steps are:

<li><p>Let <var>output</var> be the <a for=/>I/O queue</a> of bytes « <a>end-of-queue</a> ».

<li><p>Let <var>controller</var> be <var>encoder</var>'s
<a for=GenericTransformStream>transform</a>.\[[transformStreamController]].

<li>
<p>While true:

Expand All @@ -1925,11 +1886,11 @@ constructor steps are:
<li><p>Let <var>chunk</var> be a {{Uint8Array}} object wrapping an {{ArrayBuffer}} containing
<var>output</var>.

<li><p>Call <a abstract-op>TransformStreamDefaultControllerEnqueue</a>(<var>controller</var>,
<var>chunk</var>).
<li><p><a for=TransformStream>Enqueue</a> <var>chunk</var> into <var>encoder</var>'s
<a for=GenericTransformStream>transform</a>.
</ol>

<li><p>Return a new promise resolved with undefined.
<li><p>Return.
</ol>

<li><p>Let <var>result</var> be the result of executing the <a>convert code unit to scalar
Expand Down Expand Up @@ -1983,9 +1944,6 @@ that are split between strings. [[!INFRA]]
<p>If <var>encoder</var>'s <a>pending high surrogate</a> is non-null, then:

<ol>
<li><p>Let <var>controller</var> be <var>encoder</var>'s
<a for=GenericTransformStream>transform</a>.\[[transformStreamController]].

<li>
<p>Let <var>output</var> be the byte sequence 0xEF 0xBF 0xBD.

Expand All @@ -1994,11 +1952,9 @@ that are split between strings. [[!INFRA]]
<li><p>Let <var>chunk</var> be a {{Uint8Array}} object wrapping an {{ArrayBuffer}} containing
<var>output</var>.

<li><p>Call <a abstract-op>TransformStreamDefaultControllerEnqueue</a>(<var>controller</var>,
<var>chunk</var>).
<li><p><a for=TransformStream>Enqueue</a> <var>chunk</var> into <var>encoder</var>'s
<a for=GenericTransformStream>transform</a>.
</ol>

<li><p>Return a new promise resolved with undefined.
</ol>


Expand Down

0 comments on commit 7995519

Please sign in to comment.