Make IOSink implement StringSink

sdk/lib/io/io_sink.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 part of dart.io;
 
 /**
- * Helper class to wrap a [StreamConsumer<List<int>, T>] and provide utility
- * functions for writing to the StreamConsumer directly. The [IOSink]
- * buffers the input given by [add] and [addString] and will delay a [consume]
- * or [addStream] until the buffer is flushed.
+ * Helper class to wrap a [StreamConsumer<List<int>, T>] and provide
+ * utility functions for writing to the StreamConsumer directly. The
+ * [IOSink] buffers the input given by [write], [writeAll], [writeln],
+ * [writeCharCode] and [writeBytes] and will delay a [consume] or
+ * [addStream] until the buffer is flushed.
  *
  * When the [IOSink] is bound to a stream (through either [consume]
  * or [addStream]) any call to the [IOSink] will throw a
  * [StateError].
  */
-abstract class IOSink<T> implements StreamConsumer<List<int>, T> {
-  factory IOSink(StreamConsumer<List<int>, T> target)
-      => new _IOSinkImpl(target);
+abstract class IOSink<T> implements StreamConsumer<List<int>, T>, StringSink {
+  factory IOSink(StreamConsumer<List<int>, T> target, Encoding encoding)

[nweiz, 2013/03/06 20:31:51]

It looks like you're almost always initializing IOSinks with encoding set to
ASCII. First of all, it seems like UTF-8 would be a better default; otherwise
we're going to end up with a lot of Dart programs that seem functional when
testing but break as soon as they encounter non-ASCII text. Second, it seems
like encoding should be an optional parameter.

[Søren Gjesse, 2013/03/07 16:28:47]

Changed encoding to be optional with a default value of Encoding.UTF_8.

+      => new _IOSinkImpl(target, encoding);
+
+  Encoding encoding;

[nweiz, 2013/03/06 20:31:51]

Either mention here or in the http documentation that HTTP-based IOSinks take
their encoding from the associated ContentType. Also explain what happens if the
content-type is unspecified, or if it is specified with an unknown encoding.

[Søren Gjesse, 2013/03/07 16:28:47]

Added documentation to IOSink, HttpClientRequest and HttpResponse.

+
+  void writeBytes(List<int> data);
+
+  Future<T> writeStream(Stream<List<int>> stream) => addStream(stream);
 
   /**
    * Provide functionality for piping to the [IOSink].
    */
   Future<T> consume(Stream<List<int>> stream);
 
   /**
    * Like [consume], but will not close the target when done.
    */
   Future<T> addStream(Stream<List<int>> stream);
 
   /**
    * Write a list of bytes to the target.
+   *
+   * *Deprecated*. Use [writeBytes] instead.
    */
+  @deprecated

[Anders Johnsen, 2013/03/07 08:48:44]

Can't we just remote them now? They ain't part of M3.

[Søren Gjesse, 2013/03/07 16:28:47]

Done.

   void add(List<int> data);
 
   /**
    * Write a String to the target.
+   *
+   * *Deprecated*. Use [write] instead.
    */
+  @deprecated
   void addString(String string, [Encoding encoding = Encoding.UTF_8]);
 
   /**
    * Close the target.
    */
   void close();
 
   /**
    * Get future that will complete when all data has been written to
    * the IOSink and it has been closed.
    */
   Future<T> get done;
 }
 
 
 class _IOSinkImpl<T> implements IOSink<T> {
   final StreamConsumer<List<int>, T> _target;
 
   StreamController<List<int>> _controllerInstance;
   Future<T> _pipeFuture;
   StreamSubscription<List<int>> _bindSubscription;
   bool _paused = true;
+  bool _encodingMutable = true;
 
-  _IOSinkImpl(StreamConsumer<List<int>, T> target) : _target = target;
+  _IOSinkImpl(StreamConsumer<List<int>, T> this._target, Encoding encoding)
+      : _encoding = encoding;
+
+  Encoding _encoding;
+
+  Encoding get encoding => _encoding;
+  void set encoding(Encoding value) {
+    if (!_encodingMutable) {
+      throw new StateError("IOSink encoding is not mutable");
+    }
+    _encoding = value;
+  }
+
+  void write(Object obj) {
+    // This comment is copied from runtime/lib/string_buffer_patch.dart.
+    // TODO(srdjan): The following four lines could be replaced by
+    // '$obj', but apparently this is too slow on the Dart VM.
+    String string;
+    if (obj is String) {
+      string = obj;
+    } else {
+      string = obj.toString();
+      if (string is! String) {
+        throw new ArgumentError('toString() did not return a string');
+      }
+    }
+    if (string.isEmpty) return;
+    writeBytes(_encodeString(string, _encoding));
+  }
+
+  void writeAll(Iterable objects) {
+    for (Object obj in objects) write(obj);
+  }
+
+  void writeln(Object obj) {
+    write(obj);
+    write("\n");
+  }
+
+  void writeCharCode(int charCode) {
+    write(new String.fromCharCode(charCode));
+  }
+
+  void writeBytes(List<int> data) {
+    if (_isBound) {
+      throw new StateError("IOSink is already bound to a stream");
+    }
+    _controller.add(data);
+  }
 
   Future<T> consume(Stream<List<int>> stream) {
     if (_isBound) {
       throw new StateError("IOSink is already bound to a stream");
     }
     return _fillFromStream(stream);
   }
 
   Future<T> addStream(Stream<List<int>> stream) {
     if (_isBound) {
       throw new StateError("IOSink is already bound to a stream");
     }
     return _fillFromStream(stream, unbind: true);
   }
 
-  void add(List<int> data) {
-    if (_isBound) {
-      throw new StateError("IOSink is already bound to a stream");
-    }
-    _controller.add(data);
-  }
+  void add(List<int> data) => writeBytes(data);
 
   void addString(String string, [Encoding encoding = Encoding.UTF_8]) {
-    add(_encodeString(string, encoding));
+    writeBytes(_encodeString(string, encoding));
   }
 
   void close() {
     if (_isBound) {
       throw new StateError("IOSink is already bound to a stream");
     }
     _controller.close();
   }
 
   Future<T> get done {
@@ skipping 85 matching lines @@
     if (unbind) {
       _pipeFuture
           .then((_) => completeUnbind(),
                 onError: (error) => completeUnbind(error));
       return unbindCompleter.future;
     } else {
       return _pipeFuture.then((_) => this);
     }
   }
 }