pkg/compiler/lib/src/io/source_file.dart - sdk - Git at Google

 // Copyright (c) 2012, 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.

 library;

 import 'dart:convert' show utf8;
 import 'dart:math';
 import 'dart:typed_data' show Uint8List;

 import 'package:kernel/ast.dart' as kernel show Location, Source;

 import 'location_provider.dart' show LocationProvider;
 import '../../compiler_api.dart' as api show Input, InputKind;

 /// Represents a file of source code. The content can be either a [String] or
 /// a UTF-8 encoded [List<int>] of bytes.
 abstract class SourceFile implements api.Input<Uint8List>, LocationProvider {
   /// The absolute URI of the source file.
   @override
   Uri get uri;

   @override
   api.InputKind get inputKind => api.InputKind.utf8;

   kernel.Source? _cachedKernelSource;

   kernel.Source get kernelSource {
     // TODO(johnniwinther): Instead of creating a new Source object,
     // we should use the one provided by the front-end.
     return _cachedKernelSource ??= kernel.Source(
       lineStarts,
       utf8Bytes(),
       uri /* TODO(jensj): What is the import URI? */,
       uri,
     )..cachedText = slowText();
   }

   /// The name of the file.
   ///
   /// This is [uri], maybe relativized to a more human-readable form.
   String get filename => uri.toString();

   /// The text content of the file represented as a String
   String slowText();

   /// The content of the file represented as a UTF-8 encoded [Uint8List].
   Uint8List utf8Bytes();

   /// The length of the string representation of this source file, i.e.,
   /// equivalent to [:slowText().length:], but faster.
   int get length;

   /// Sets the string length of this source file. For source files based on
   /// UTF-8 byte arrays, the string length is computed and assigned by the
   /// scanner.
   set length(int v);

   /// A map from line numbers to offsets in the string text representation of
   /// this source file.
   List<int> get lineStarts {
     // When reporting errors during scanning, the line numbers are not yet
     // available and need to be computed using this slow path.
     // TODO(sra): Scanning is now done entirely by the CFE.
     return _lineStartsCache ??= _lineStartsFromString(slowText());
   }

   /// Sets the line numbers map for this source file. This map is computed and
   /// assigned by the scanner, avoiding a separate traversal of the source file.
   ///
   /// The map contains one additional entry at the end of the file, as if the
   /// source file had one more empty line at the end. This simplifies the binary
   /// search in [getLocation].
   set lineStarts(List<int> v) => _lineStartsCache = v;

   List<int>? _lineStartsCache;

   static List<int> _lineStartsFromString(String text) {
     var starts = [0];
     var index = 0;
     while (index < text.length) {
       index = text.indexOf('\n', index) + 1;
       if (index <= 0) break;
       starts.add(index);
     }
     starts.add(text.length + 1); // One additional line start at the end.
     return starts;
   }

   @override
   kernel.Location getLocation(int offset) {
     return kernelSource.getLocation(uri, offset);
   }

   String slowSubstring(int start, int end);

   /// Create a pretty string representation for [message] from a character
   /// range `[start, end]` in this file.
   ///
   /// If [includeSourceLine] is `true` the first source line code line that
   /// contains the range will be included as well as marker characters ('^')
   /// underlining the range.
   ///
   /// Use [colorize] to wrap source code text and marker characters in color
   /// escape codes.
   String getLocationMessage(
     String message,
     int start,
     int end, {
     bool includeSourceLine = true,
     String Function(String text)? colorize,
   }) {
     colorize ??= (text) => text;

     StringBuffer buf = StringBuffer('$filename:');
     bool wroteMessage = false;
     try {
       kernel.Location startLocation = kernelSource.getLocation(uri, start);
       kernel.Location endLocation = kernelSource.getLocation(uri, end);
       int lineStart = startLocation.line - 1;
       int columnStart = startLocation.column - 1;
       int lineEnd = endLocation.line - 1;
       int columnEnd = endLocation.column - 1;

       if (start != end || start != 0) {
         // Line/column info is relevant.
         buf.write('${lineStart + 1}:${columnStart + 1}:');
       }
       buf.write('\n$message\n');
       wroteMessage = true;

       if (start != end && includeSourceLine) {
         if (lineStart == lineEnd) {
           String textLine = kernelSource.getTextLine(startLocation.line)!;

           int toColumn = min(columnStart + (end - start), textLine.length);
           buf.write(textLine.substring(0, columnStart));
           buf.write(colorize(textLine.substring(columnStart, toColumn)));
           buf.writeln(textLine.substring(toColumn));

           int i = 0;
           for (; i < columnStart; i++) {
             buf.write(' ');
           }

           for (; i < toColumn; i++) {
             buf.write(colorize('^'));
           }
         } else {
           for (int line = lineStart; line <= lineEnd; line++) {
             String textLine = kernelSource.getTextLine(line + 1)!;
             if (line == lineStart) {
               if (columnStart > textLine.length) {
                 columnStart = textLine.length;
               }
               buf.write(textLine.substring(0, columnStart));
               buf.writeln(colorize(textLine.substring(columnStart)));
             } else if (line == lineEnd) {
               if (columnEnd > textLine.length) {
                 columnEnd = textLine.length;
               }
               buf.write(colorize(textLine.substring(0, columnEnd)));
               buf.writeln(textLine.substring(columnEnd));
             } else {
               buf.writeln(colorize(textLine));
             }
           }
         }
       }
     } catch (e) {
       if (!wroteMessage) {
         buf.write('+$start');
         buf.write('\n$message\n');
         buf.write('$e\n');
       }
     }

     return buf.toString();
   }

   int get lines => lineStarts.length - 1;
 }

 class Utf8BytesSourceFile extends SourceFile {
   @override
   final Uri uri;

   /// The UTF-8 encoded content of the source file.
   final Uint8List content;

   /// Creates a Utf8BytesSourceFile.
   Utf8BytesSourceFile(this.uri, this.content) : assert(content.last != 0);

   @override
   Uint8List get data => content;

   @override
   String slowText() {
     return utf8.decode(content, allowMalformed: true);
   }

   @override
   Uint8List utf8Bytes() => content;

   @override
   String slowSubstring(int start, int end) {
     // TODO(lry): to make this faster, the scanner could record the UTF-8 slack
     // for all positions of the source text. We could use [:content.sublist:].
     return slowText().substring(start, end);
   }

   @override
   int get length {
     if (lengthCache == -1) {
       // During scanning the length is not yet assigned, so we use a slow path.
       lengthCache = slowText().length;
     }
     return lengthCache;
   }

   @override
   set length(int v) => lengthCache = v;
   int lengthCache = -1;

   @override
   void release() {}
 }

 class StringSourceFile extends SourceFile {
   @override
   final Uri uri;
   @override
   final String filename;
   final String text;

   StringSourceFile(this.uri, this.filename, this.text);

   StringSourceFile.fromUri(Uri uri, String text)
     : this(uri, uri.toString(), text);

   StringSourceFile.fromName(String filename, String text)
     : this(Uri(path: filename), filename, text);

   @override
   Uint8List get data => utf8.encode(text);

   @override
   int get length => text.length;
   @override
   set length(int v) {}

   @override
   String slowText() => text;

   @override
   Uint8List utf8Bytes() {
     return utf8.encode(text);
   }

   @override
   String slowSubstring(int start, int end) => text.substring(start, end);

   @override
   void release() {}
 }

 /// Binary input data.
 class Binary implements api.Input<Uint8List> {
   @override
   final Uri uri;
   Uint8List? _data;

   Binary(this.uri, Uint8List data) : _data = data;

   @override
   Uint8List get data {
     if (_data != null) return _data!;
     throw StateError("'get data' after 'release()'");
   }

   @override
   api.InputKind get inputKind => api.InputKind.binary;

   @override
   void release() {
     _data = null;
   }
 }
	// Copyright (c) 2012, 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.

	library;

	import 'dart:convert' show utf8;
	import 'dart:math';
	import 'dart:typed_data' show Uint8List;

	import 'package:kernel/ast.dart' as kernel show Location, Source;

	import 'location_provider.dart' show LocationProvider;
	import '../../compiler_api.dart' as api show Input, InputKind;

	/// Represents a file of source code. The content can be either a [String] or
	/// a UTF-8 encoded [List<int>] of bytes.
	abstract class SourceFile implements api.Input<Uint8List>, LocationProvider {
	/// The absolute URI of the source file.
	@override
	Uri get uri;

	@override
	api.InputKind get inputKind => api.InputKind.utf8;

	kernel.Source? _cachedKernelSource;

	kernel.Source get kernelSource {
	// TODO(johnniwinther): Instead of creating a new Source object,
	// we should use the one provided by the front-end.
	return _cachedKernelSource ??= kernel.Source(
	lineStarts,
	utf8Bytes(),
	uri /* TODO(jensj): What is the import URI? */,
	uri,
	)..cachedText = slowText();
	}

	/// The name of the file.
	///
	/// This is [uri], maybe relativized to a more human-readable form.
	String get filename => uri.toString();

	/// The text content of the file represented as a String
	String slowText();

	/// The content of the file represented as a UTF-8 encoded [Uint8List].
	Uint8List utf8Bytes();

	/// The length of the string representation of this source file, i.e.,
	/// equivalent to [:slowText().length:], but faster.
	int get length;

	/// Sets the string length of this source file. For source files based on
	/// UTF-8 byte arrays, the string length is computed and assigned by the
	/// scanner.
	set length(int v);

	/// A map from line numbers to offsets in the string text representation of
	/// this source file.
	List<int> get lineStarts {
	// When reporting errors during scanning, the line numbers are not yet
	// available and need to be computed using this slow path.
	// TODO(sra): Scanning is now done entirely by the CFE.
	return _lineStartsCache ??= _lineStartsFromString(slowText());
	}

	/// Sets the line numbers map for this source file. This map is computed and
	/// assigned by the scanner, avoiding a separate traversal of the source file.
	///
	/// The map contains one additional entry at the end of the file, as if the
	/// source file had one more empty line at the end. This simplifies the binary
	/// search in [getLocation].
	set lineStarts(List<int> v) => _lineStartsCache = v;

	List<int>? _lineStartsCache;

	static List<int> _lineStartsFromString(String text) {
	var starts = [0];
	var index = 0;
	while (index < text.length) {
	index = text.indexOf('\n', index) + 1;
	if (index <= 0) break;
	starts.add(index);
	}
	starts.add(text.length + 1); // One additional line start at the end.
	return starts;
	}

	@override
	kernel.Location getLocation(int offset) {
	return kernelSource.getLocation(uri, offset);
	}

	String slowSubstring(int start, int end);

	/// Create a pretty string representation for [message] from a character
	/// range `[start, end]` in this file.
	///
	/// If [includeSourceLine] is `true` the first source line code line that
	/// contains the range will be included as well as marker characters ('^')
	/// underlining the range.
	///
	/// Use [colorize] to wrap source code text and marker characters in color
	/// escape codes.
	String getLocationMessage(
	String message,
	int start,
	int end, {
	bool includeSourceLine = true,
	String Function(String text)? colorize,
	}) {
	colorize ??= (text) => text;

	StringBuffer buf = StringBuffer('$filename:');
	bool wroteMessage = false;
	try {
	kernel.Location startLocation = kernelSource.getLocation(uri, start);
	kernel.Location endLocation = kernelSource.getLocation(uri, end);
	int lineStart = startLocation.line - 1;
	int columnStart = startLocation.column - 1;
	int lineEnd = endLocation.line - 1;
	int columnEnd = endLocation.column - 1;

	if (start != end \|\| start != 0) {
	// Line/column info is relevant.
	buf.write('${lineStart + 1}:${columnStart + 1}:');
	}
	buf.write('\n$message\n');
	wroteMessage = true;

	if (start != end && includeSourceLine) {
	if (lineStart == lineEnd) {
	String textLine = kernelSource.getTextLine(startLocation.line)!;

	int toColumn = min(columnStart + (end - start), textLine.length);
	buf.write(textLine.substring(0, columnStart));
	buf.write(colorize(textLine.substring(columnStart, toColumn)));
	buf.writeln(textLine.substring(toColumn));

	int i = 0;
	for (; i < columnStart; i++) {
	buf.write(' ');
	}

	for (; i < toColumn; i++) {
	buf.write(colorize('^'));
	}
	} else {
	for (int line = lineStart; line <= lineEnd; line++) {
	String textLine = kernelSource.getTextLine(line + 1)!;
	if (line == lineStart) {
	if (columnStart > textLine.length) {
	columnStart = textLine.length;
	}
	buf.write(textLine.substring(0, columnStart));
	buf.writeln(colorize(textLine.substring(columnStart)));
	} else if (line == lineEnd) {
	if (columnEnd > textLine.length) {
	columnEnd = textLine.length;
	}
	buf.write(colorize(textLine.substring(0, columnEnd)));
	buf.writeln(textLine.substring(columnEnd));
	} else {
	buf.writeln(colorize(textLine));
	}
	}
	}
	}
	} catch (e) {
	if (!wroteMessage) {
	buf.write('+$start');
	buf.write('\n$message\n');
	buf.write('$e\n');
	}
	}

	return buf.toString();
	}

	int get lines => lineStarts.length - 1;
	}

	class Utf8BytesSourceFile extends SourceFile {
	@override
	final Uri uri;

	/// The UTF-8 encoded content of the source file.
	final Uint8List content;

	/// Creates a Utf8BytesSourceFile.
	Utf8BytesSourceFile(this.uri, this.content) : assert(content.last != 0);

	@override
	Uint8List get data => content;

	@override
	String slowText() {
	return utf8.decode(content, allowMalformed: true);
	}

	@override
	Uint8List utf8Bytes() => content;

	@override
	String slowSubstring(int start, int end) {
	// TODO(lry): to make this faster, the scanner could record the UTF-8 slack
	// for all positions of the source text. We could use [:content.sublist:].
	return slowText().substring(start, end);
	}

	@override
	int get length {
	if (lengthCache == -1) {
	// During scanning the length is not yet assigned, so we use a slow path.
	lengthCache = slowText().length;
	}
	return lengthCache;
	}

	@override
	set length(int v) => lengthCache = v;
	int lengthCache = -1;

	@override
	void release() {}
	}

	class StringSourceFile extends SourceFile {
	@override
	final Uri uri;
	@override
	final String filename;
	final String text;

	StringSourceFile(this.uri, this.filename, this.text);

	StringSourceFile.fromUri(Uri uri, String text)
	: this(uri, uri.toString(), text);

	StringSourceFile.fromName(String filename, String text)
	: this(Uri(path: filename), filename, text);

	@override
	Uint8List get data => utf8.encode(text);

	@override
	int get length => text.length;
	@override
	set length(int v) {}

	@override
	String slowText() => text;

	@override
	Uint8List utf8Bytes() {
	return utf8.encode(text);
	}

	@override
	String slowSubstring(int start, int end) => text.substring(start, end);

	@override
	void release() {}
	}

	/// Binary input data.
	class Binary implements api.Input<Uint8List> {
	@override
	final Uri uri;
	Uint8List? _data;

	Binary(this.uri, Uint8List data) : _data = data;

	@override
	Uint8List get data {
	if (_data != null) return _data!;
	throw StateError("'get data' after 'release()'");
	}

	@override
	api.InputKind get inputKind => api.InputKind.binary;

	@override
	void release() {
	_data = null;
	}
	}