CQ. Make FileSource API, move to lib/source.

Change-Id: I981d3f0904917ada322ca06448f03ff33ae1f095
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/369360
Commit-Queue: Konstantin Shcheglov <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>

Author: scheglov

pkg/analysis_server/lib/src/computer/import_elements_computer.dart

@@ -7,9 +7,9 @@ import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/generated/source.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart' hide Element;
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/range_factory.dart';

pkg/analysis_server/lib/src/context_manager.dart

@@ -14,6 +14,7 @@ import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/overlay_file_system.dart';
 import 'package:analyzer/instrumentation/instrumentation.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/src/dart/analysis/analysis_context_collection.dart';
 import 'package:analyzer/src/dart/analysis/byte_store.dart';
@@ -26,7 +27,6 @@ import 'package:analyzer/src/dart/analysis/unlinked_unit_store.dart';
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/manifest/manifest_validator.dart';
 import 'package:analyzer/src/pubspec/pubspec_validator.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/task/options.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer/src/workspace/blaze.dart';

pkg/analysis_server/lib/src/handler/legacy/edit_get_fixes.dart

@@ -18,14 +18,14 @@ import 'package:analysis_server_plugin/edit/fix/fix.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/analysis/session.dart';
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/src/analysis_options/analysis_options_provider.dart';
 import 'package:analyzer/src/dart/analysis/results.dart' as engine;
 import 'package:analyzer/src/exception/exception.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/source.dart' show SourceFactory;
 import 'package:analyzer/src/pubspec/pubspec_validator.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/task/options.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer/src/util/file_paths.dart';

pkg/analysis_server/lib/src/lsp/handlers/code_actions/analysis_options.dart

@@ -7,10 +7,10 @@ import 'dart:async';
 import 'package:analysis_server/lsp_protocol/protocol.dart';
 import 'package:analysis_server/src/lsp/handlers/code_actions/abstract_code_actions_producer.dart';
 import 'package:analysis_server/src/services/correction/fix/analysis_options/fix_generator.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/src/analysis_options/analysis_options_provider.dart';
 import 'package:analyzer/src/generated/source.dart' show SourceFactory;
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/task/options.dart';
 import 'package:analyzer/src/workspace/pub.dart';
 import 'package:yaml/yaml.dart';

pkg/analysis_server/lib/src/lsp/handlers/code_actions/pubspec.dart

@@ -7,9 +7,9 @@ import 'dart:async';
 import 'package:analysis_server/lsp_protocol/protocol.dart';
 import 'package:analysis_server/src/lsp/handlers/code_actions/abstract_code_actions_producer.dart';
 import 'package:analysis_server/src/services/correction/fix/pubspec/fix_generator.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/src/pubspec/pubspec_validator.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:yaml/yaml.dart';
 
 /// Produces [CodeAction]s from Pubspec fixes.

pkg/analysis_server/lib/src/services/correction/bulk_fix_processor.dart

@@ -28,6 +28,7 @@ import 'package:analyzer/exception/exception.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/instrumentation/service.dart';
 import 'package:analyzer/source/error_processor.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/source/source_range.dart';
 import 'package:analyzer/src/dart/ast/utilities.dart';
@@ -38,7 +39,6 @@ import 'package:analyzer/src/lint/linter_visitor.dart';
 import 'package:analyzer/src/lint/registry.dart';
 import 'package:analyzer/src/pubspec/pubspec_warning_code.dart';
 import 'package:analyzer/src/pubspec/validators/missing_dependency_validator.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/string_source.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer/src/util/performance/operation_performance.dart';

pkg/analysis_server/lib/src/services/correction/fix/data_driven/transform_set_manager.dart

@@ -7,7 +7,7 @@ import 'package:analysis_server/src/services/correction/fix/data_driven/transfor
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/file_system/file_system.dart';
-import 'package:analyzer/src/source/source_resource.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:meta/meta.dart';
 
 /// An object used to manage the transform sets.

pkg/analysis_server/test/src/services/correction/fix/analysis_options/test_support.dart

@@ -5,9 +5,9 @@
 import 'package:analysis_server/src/services/correction/fix/analysis_options/fix_generator.dart';
 import 'package:analysis_server_plugin/edit/fix/fix.dart';
 import 'package:analyzer/error/error.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:analyzer/src/lint/state.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/task/options.dart';
 import 'package:analyzer/src/test_utilities/resource_provider_mixin.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart'

pkg/analysis_server/test/src/services/correction/fix/pubspec/add_dependency_test.dart

@@ -3,8 +3,8 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/src/services/correction/fix/pubspec/fix_kind.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/src/pubspec/validators/missing_dependency_validator.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 import 'package:matcher/expect.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';

pkg/analysis_server/test/src/services/correction/fix/pubspec/test_support.dart

@@ -6,9 +6,9 @@ import 'package:analysis_server/src/protocol_server.dart' show SourceEdit;
 import 'package:analysis_server/src/services/correction/fix/pubspec/fix_generator.dart';
 import 'package:analysis_server_plugin/edit/fix/fix.dart';
 import 'package:analyzer/error/error.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/src/pubspec/pubspec_validator.dart'
     as pubspec_validator;
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/test_utilities/resource_provider_mixin.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 import 'package:test/test.dart';

pkg/analyzer/CHANGELOG.md

@@ -1,6 +1,8 @@
 ## 6.6.0-dev
 * Stop exporting `src/file_system/file_system.dart`
   from `file_system/file_system.dart`.
+* Deprecated `package:analyzer/src/source/source_resource.dart`,
+  import `package:analyzer/source/file_source.dart` instead.
 
 ## 6.5.2
 * Updated constraints `macros: '>=0.1.2-0 <0.1.3'`.

pkg/analyzer/lib/file_system/memory_file_system.dart

@@ -7,8 +7,8 @@ import 'dart:convert';
 import 'dart:typed_data';
 
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/test_utilities/resource_provider_mixin.dart';
 import 'package:meta/meta.dart';
 import 'package:path/path.dart' as pathos;

pkg/analyzer/lib/file_system/overlay_file_system.dart

@@ -6,8 +6,8 @@ import 'dart:convert';
 import 'dart:typed_data';
 
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:path/path.dart' as pathos;
 import 'package:watcher/watcher.dart';
 

pkg/analyzer/lib/file_system/physical_file_system.dart

@@ -7,8 +7,8 @@ import 'dart:io' as io;
 import 'dart:typed_data';
 
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/src/generated/source.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:path/path.dart';
 import 'package:watcher/watcher.dart';
 

pkg/analyzer/lib/source/file_source.dart

@@ -0,0 +1,99 @@
+// Copyright (c) 2016, 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.
+
+import 'dart:collection';
+
+import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/source.dart';
+import 'package:analyzer/src/generated/engine.dart';
+import 'package:analyzer/src/generated/source.dart';
+
+/// A function that can translate the contents of files on disk as they are
+/// read. This is now obsolete, but supported the ability of server to deal with
+/// clients that convert all text to an internal format.
+@Deprecated('We will remove reading source content')
+typedef FileReadMode = String Function(String s);
+
+/// A source that represents a file.
+class FileSource extends Source {
+  /// A function that changes the way that files are read off of disk.
+  @Deprecated('We will remove reading source content')
+  static FileReadMode fileReadMode = (String s) => s;
+
+  /// Map from encoded URI/filepath pair to a unique integer identifier.  This
+  /// identifier is used for equality tests and hash codes.
+  ///
+  /// The URI and filepath are joined into a pair by separating them with an '@'
+  /// character.
+  static final Map<String, int> _idTable = HashMap<String, int>();
+
+  /// The URI from which this source was originally derived.
+  @override
+  final Uri uri;
+
+  /// The unique ID associated with this source.
+  final int id;
+
+  /// The file represented by this source.
+  final File file;
+
+  /// The cached absolute path of this source.
+  String? _absolutePath;
+
+  /// Initialize a newly created source object to represent the given [file]. If
+  /// a [uri] is given, then it will be used as the URI from which the source
+  /// was derived, otherwise a `file:` URI will be created based on the [file].
+  FileSource(this.file, [Uri? uri])
+      : uri = uri ?? file.toUri(),
+        id = _idTable.putIfAbsent(
+            '${uri ?? file.toUri()}@${file.path}', () => _idTable.length);
+
+  @override
+  TimestampedData<String> get contents {
+    return contentsFromFile;
+  }
+
+  /// Get and return the contents and timestamp of the underlying file.
+  ///
+  /// Clients should consider using the method [AnalysisContext.getContents]
+  /// because contexts can have local overrides of the content of a source that
+  /// the source is not aware of.
+  ///
+  /// Throws an exception if the contents of this source could not be accessed.
+  /// See [contents].
+  TimestampedData<String> get contentsFromFile {
+    return TimestampedData<String>(
+      file.modificationStamp,
+      // ignore:deprecated_member_use_from_same_package
+      fileReadMode(file.readAsStringSync()),
+    );
+  }
+
+  @override
+  String get fullName => _absolutePath ??= file.path;
+
+  @override
+  int get hashCode => uri.hashCode;
+
+  @override
+  String get shortName => file.shortName;
+
+  @override
+  bool operator ==(Object other) {
+    if (other is FileSource) {
+      return id == other.id;
+    } else if (other is Source) {
+      return uri == other.uri;
+    }
+    return false;
+  }
+
+  @override
+  bool exists() => file.exists;
+
+  @override
+  String toString() {
+    return file.path;
+  }
+}

pkg/analyzer/lib/src/analysis_options/analysis_options_provider.dart

@@ -3,9 +3,9 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/generated/source.dart' show SourceFactory;
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/task/options.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer/src/util/yaml.dart';

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

@@ -12,6 +12,7 @@ import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/dart/analysis/analysis_options_map.dart';
@@ -32,7 +33,6 @@ import 'package:analyzer/src/exception/exception.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/parser.dart';
 import 'package:analyzer/src/generated/source.dart' show SourceFactory;
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/summary/api_signature.dart';
 import 'package:analyzer/src/summary/package_bundle_reader.dart';
 import 'package:analyzer/src/summary2/informative_data.dart';

pkg/analyzer/lib/src/dart/sdk/sdk.dart

@@ -10,12 +10,12 @@ import 'package:analyzer/dart/analysis/utilities.dart';
 import 'package:analyzer/exception/exception.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/memory_file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/src/dart/sdk/sdk_utils.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/java_engine_io.dart';
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/generated/source.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/utilities/uri_cache.dart';
 import 'package:pub_semver/pub_semver.dart';
 import 'package:yaml/yaml.dart';

pkg/analyzer/lib/src/file_system/file_system.dart

@@ -3,9 +3,9 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/generated/source.dart' show UriResolver;
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/util/uri.dart';
 
 /// A [UriResolver] for [Resource]s.

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

@@ -8,6 +8,7 @@ import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/instrumentation/instrumentation.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/analysis_options/analysis_options_provider.dart';
 import 'package:analyzer/src/analysis_options/apply_options.dart';
@@ -16,7 +17,6 @@ import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/lint/io.dart';
 import 'package:analyzer/src/lint/linter.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 
 AnalysisOptionsProvider _optionsProvider = AnalysisOptionsProvider();
 

pkg/analyzer/lib/src/lint/pub.dart

@@ -6,8 +6,8 @@ import 'dart:collection';
 
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:source_span/source_span.dart';
 import 'package:yaml/yaml.dart';
 

pkg/analyzer/lib/src/source/package_map_resolver.dart

@@ -3,9 +3,9 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/generated/source.dart' show UriResolver;
-import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/util/asserts.dart' as asserts;
 import 'package:analyzer/src/utilities/uri_cache.dart';
 import 'package:path/path.dart' as pathos;