Fine. Rename binary I/O types to BinaryReader/Writer

Replace the generic names `SummaryDataReader` and `BufferedSink` with
clearer `BinaryReader` and `BinaryWriter`. The new names reflect their
actual roles (reading/writing the analyzer’s binary formats), reduce
confusion with “summary” artifacts, and make call sites easier to scan.
No encoding or behavioral changes are intended.

Key changes
- Introduce `BinaryReader` and `BinaryWriter` and update class docs.
- Rename constructor, method, and factory signatures across the codebase
  to use the new types (e.g., `read(...)`, `write(...)`, `fork(...)`).
- Update extensions to match the new names (`BinaryReaderExtension`,
  `BinaryWriterExtension`) and migrate helper methods accordingly.
- Adjust `string_table.dart` to take `BinaryWriter` and update `_writeWtf8`.
- Update readers/writers throughout analyzer components:
  - library context/diagnostics, unlinked data, manifests, IDs, items,
    types, requirements, and informative data.
  - utilities for `EnumSet.read`/`write`.
  - summary2 bundle reader/writer and package bundle format.
- Keep `_SummaryDataWriter` as an internal adapter now extending
  `BinaryWriter`.

Compatibility
- Binary format is unchanged; this is a pure rename refactor.
- Endianness, variable-length encodings, and offsets remain identical.

Change-Id: I97c07a708c1bd649084fc78a7c60c583964109ca
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/450950
Commit-Queue: Konstantin Shcheglov <[email protected]>
Reviewed-by: Johnni Winther <[email protected]>

Author: scheglov

pkg/analyzer/lib/src/binary/binary_reader.dart

@@ -8,8 +8,8 @@ import 'dart:typed_data';
 import 'package:_fe_analyzer_shared/src/scanner/string_canonicalizer.dart';
 import 'package:analyzer/src/binary/string_table.dart';
 
-/// Helper for reading primitive types from bytes.
-class SummaryDataReader {
+/// Reader for binary formats.
+class BinaryReader {
   final Uint8List bytes;
   int offset = 0;
 
@@ -21,16 +21,16 @@ class SummaryDataReader {
   final Float64List _doubleBuffer = Float64List(1);
   late final Uint8List _doubleBufferUint8 = _doubleBuffer.buffer.asUint8List();
 
-  SummaryDataReader(this.bytes);
+  BinaryReader(this.bytes);
 
   void createStringTable(int offset) {
     _stringTable = StringTable(bytes: bytes, startOffset: offset);
   }
 
   /// Create a new instance with the given [offset].
   /// It shares the same bytes and string reader.
-  SummaryDataReader fork(int offset) {
-    var result = SummaryDataReader(bytes);
+  BinaryReader fork(int offset) {
+    var result = BinaryReader(bytes);
     result.offset = offset;
     result._stringTable = _stringTable;
     return result;

pkg/analyzer/lib/src/binary/binary_writer.dart

@@ -5,8 +5,8 @@
 import 'dart:convert';
 import 'dart:typed_data';
 
-/// Puts a buffer in front of a [Sink<List<int>>].
-class BufferedSink {
+/// Buffered writer for binary formats.
+class BinaryWriter {
   static const int _SIZE = 128 * 1024;
   static const int _SAFE_LENGTH = _SIZE - 5;
 
@@ -21,7 +21,7 @@ class BufferedSink {
   final Float64List _doubleBuffer = Float64List(1);
   late final Uint8List _doubleBufferUint8 = _doubleBuffer.buffer.asUint8List();
 
-  BufferedSink();
+  BinaryWriter();
 
   int get offset => _builder.length + _length;
 

pkg/analyzer/lib/src/binary/string_table.dart

@@ -21,29 +21,29 @@ class StringIndexer {
     return result;
   }
 
-  int write(BufferedSink sink) {
-    var bytesOffset = sink.offset;
+  int write(BinaryWriter writer) {
+    var bytesOffset = writer.offset;
 
     var length = _index.length;
     var lengths = Uint32List(length);
     var lengthsIndex = 0;
     for (var key in _index.keys) {
-      var stringStart = sink.offset;
-      _writeWtf8(sink, key);
-      lengths[lengthsIndex++] = sink.offset - stringStart;
+      var stringStart = writer.offset;
+      _writeWtf8(writer, key);
+      lengths[lengthsIndex++] = writer.offset - stringStart;
     }
 
-    var resultOffset = sink.offset;
+    var resultOffset = writer.offset;
 
-    var lengthOfBytes = sink.offset - bytesOffset;
-    sink.writeUint30(lengthOfBytes);
-    sink.writeUint30List(lengths);
+    var lengthOfBytes = writer.offset - bytesOffset;
+    writer.writeUint30(lengthOfBytes);
+    writer.writeUint30List(lengths);
 
     return resultOffset;
   }
 
-  /// Write [source] string into [sink].
-  static void _writeWtf8(BufferedSink sink, String source) {
+  /// Write [source] string into [writer].
+  static void _writeWtf8(BinaryWriter writer, String source) {
     var end = source.length;
     if (end == 0) {
       return;
@@ -54,28 +54,28 @@ class StringIndexer {
       var codeUnit = source.codeUnitAt(i++);
       if (codeUnit < 128) {
         // ASCII.
-        sink.writeByte(codeUnit);
+        writer.writeByte(codeUnit);
       } else if (codeUnit < 0x800) {
         // Two-byte sequence (11-bit unicode value).
-        sink.writeByte(0xC0 | (codeUnit >> 6));
-        sink.writeByte(0x80 | (codeUnit & 0x3f));
+        writer.writeByte(0xC0 | (codeUnit >> 6));
+        writer.writeByte(0x80 | (codeUnit & 0x3f));
       } else if ((codeUnit & 0xFC00) == 0xD800 &&
           i < end &&
           (source.codeUnitAt(i) & 0xFC00) == 0xDC00) {
         // Surrogate pair -> four-byte sequence (non-BMP unicode value).
         int codeUnit2 = source.codeUnitAt(i++);
         int unicode =
             0x10000 + ((codeUnit & 0x3FF) << 10) + (codeUnit2 & 0x3FF);
-        sink.writeByte(0xF0 | (unicode >> 18));
-        sink.writeByte(0x80 | ((unicode >> 12) & 0x3F));
-        sink.writeByte(0x80 | ((unicode >> 6) & 0x3F));
-        sink.writeByte(0x80 | (unicode & 0x3F));
+        writer.writeByte(0xF0 | (unicode >> 18));
+        writer.writeByte(0x80 | ((unicode >> 12) & 0x3F));
+        writer.writeByte(0x80 | ((unicode >> 6) & 0x3F));
+        writer.writeByte(0x80 | (unicode & 0x3F));
       } else {
         // Three-byte sequence (16-bit unicode value), including lone
         // surrogates.
-        sink.writeByte(0xE0 | (codeUnit >> 12));
-        sink.writeByte(0x80 | ((codeUnit >> 6) & 0x3f));
-        sink.writeByte(0x80 | (codeUnit & 0x3f));
+        writer.writeByte(0xE0 | (codeUnit >> 12));
+        writer.writeByte(0x80 | ((codeUnit >> 6) & 0x3f));
+        writer.writeByte(0x80 | (codeUnit & 0x3f));
       }
     } while (i < end);
   }

pkg/analyzer/lib/src/dart/analysis/library_context.dart

@@ -551,7 +551,7 @@ class LinkedBundleProvider {
     }
 
     performance.getDataInt('bytesLength').add(bytes.length);
-    var reader = SummaryDataReader(bytes);
+    var reader = BinaryReader(bytes);
     var nonTransitiveApiSignature = reader.readStringUtf8();
     var libraryManifests = reader.readMap(
       readKey: () => reader.readUri(),
@@ -582,18 +582,18 @@ class LinkedBundleProvider {
     required LinkedBundleEntry entry,
     required OperationPerformanceImpl performance,
   }) {
-    var sink = BufferedSink();
+    var writer = BinaryWriter();
 
-    sink.writeStringUtf8(entry.nonTransitiveApiSignature);
-    sink.writeMap(
+    writer.writeStringUtf8(entry.nonTransitiveApiSignature);
+    writer.writeMap(
       entry.libraryManifests,
-      writeKey: (uri) => sink.writeUri(uri),
-      writeValue: (manifest) => manifest.write(sink),
+      writeKey: (uri) => writer.writeUri(uri),
+      writeValue: (manifest) => manifest.write(writer),
     );
-    entry.requirements.write(sink);
-    sink.writeUint8List(entry.linkedBytes);
+    entry.requirements.write(writer);
+    writer.writeUint8List(entry.linkedBytes);
 
-    var bytes = sink.takeBytes();
+    var bytes = writer.takeBytes();
     byteStore.putGet(key, bytes);
     performance.getDataInt('bytes').add(bytes.length);
 

pkg/analyzer/lib/src/dart/analysis/library_diagnostics.dart

@@ -32,7 +32,7 @@ class LibraryDiagnosticsBundle {
   });
 
   factory LibraryDiagnosticsBundle.fromBytes(Uint8List bytes) {
-    var reader = SummaryDataReader(bytes);
+    var reader = BinaryReader(bytes);
     return LibraryDiagnosticsBundle(
       requirements: RequirementsManifest.read(reader),
       serializedFileResults: reader.readMap(
@@ -51,13 +51,13 @@ class LibraryDiagnosticsBundle {
   }
 
   Uint8List toBytes() {
-    var sink = BufferedSink();
-    requirements.write(sink);
-    sink.writeMap(
+    var writer = BinaryWriter();
+    requirements.write(writer);
+    writer.writeMap(
       serializedFileResults,
-      writeKey: (uri) => sink.writeUri(uri),
-      writeValue: (bytes) => sink.writeUint8List(bytes),
+      writeKey: (uri) => writer.writeUri(uri),
+      writeValue: (bytes) => writer.writeUint8List(bytes),
     );
-    return sink.takeBytes();
+    return writer.takeBytes();
   }
 }