pkg/analyzer/lib/src/summary2/linked_element_factory.dart - sdk.git - Git at Google

 // Copyright (c) 2019, 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 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/src/context/context.dart';
 import 'package:analyzer/src/dart/analysis/session.dart';
 import 'package:analyzer/src/dart/element/element.dart';
 import 'package:analyzer/src/dart/element/type_provider.dart';
 import 'package:analyzer/src/dart/resolver/scope.dart';
 import 'package:analyzer/src/summary2/bundle_reader.dart';
 import 'package:analyzer/src/summary2/linked_library_context.dart';
 import 'package:analyzer/src/summary2/reference.dart';

 class LinkedElementFactory {
   final AnalysisContextImpl analysisContext;
   final AnalysisSessionImpl analysisSession;
   final Reference rootReference;
   final Map<String, LibraryReader> libraryReaders = {};

   bool isApplyingInformativeData = false;

   LinkedElementFactory(
     this.analysisContext,
     this.analysisSession,
     this.rootReference,
   ) {
     ArgumentError.checkNotNull(analysisContext, 'analysisContext');
     ArgumentError.checkNotNull(analysisSession, 'analysisSession');
     _declareDartCoreDynamicNever();
   }

   Reference get dynamicRef {
     return rootReference.getChild('dart:core').getChild('dynamic');
   }

   bool get hasDartCore {
     return libraryReaders.containsKey('dart:core');
   }

   void addBundle(BundleReader bundle) {
     addLibraries(bundle.libraryMap);
   }

   void addLibraries(Map<String, LibraryReader> libraries) {
     libraryReaders.addAll(libraries);
   }

   Namespace buildExportNamespace(Uri uri) {
     var exportedNames = <String, Element>{};

     var exportedReferences = exportsOfLibrary('$uri');
     for (var exportedReference in exportedReferences) {
       var element = elementOfReference(exportedReference);
       // TODO(scheglov) Remove after https://github.com/dart-lang/sdk/issues/41212
       if (element == null) {
         throw StateError(
           '[No element]'
           '[uri: $uri]'
           '[exportedReferences: $exportedReferences]'
           '[exportedReference: $exportedReference]',
         );
       }
       exportedNames[element.name!] = element;
     }

     return Namespace(exportedNames);
   }

   LibraryElementImpl? createLibraryElementForLinking(
     LinkedLibraryContext libraryContext,
   ) {
     var sourceFactory = analysisContext.sourceFactory;
     var libraryUriStr = libraryContext.uriStr;
     var librarySource = sourceFactory.forUri(libraryUriStr);

     // The URI cannot be resolved, we don't know the library.
     if (librarySource == null) return null;

     var definingUnitContext = libraryContext.definingUnit;
     var definingUnitNode = definingUnitContext.unit;

     // TODO(scheglov) Do we need this?
     var name = '';
     var nameOffset = -1;
     var nameLength = 0;
     for (var directive in definingUnitNode.directives) {
       if (directive is LibraryDirective) {
         name = directive.name.components.map((e) => e.name).join('.');
         nameOffset = directive.name.offset;
         nameLength = directive.name.length;
         break;
       }
     }

     var libraryElement = LibraryElementImpl(
       analysisContext,
       analysisSession,
       name,
       nameOffset,
       nameLength,
       definingUnitNode.featureSet,
     );
     libraryElement.isSynthetic = definingUnitContext.isSynthetic;
     libraryElement.languageVersion = definingUnitNode.languageVersion!;
     _bindReference(libraryContext.reference, libraryElement);
     _setLibraryTypeSystem(libraryElement);

     var units = <CompilationUnitElementImpl>[];
     for (var unitContext in libraryContext.units) {
       var unitNode = unitContext.unit;

       var unitSource = sourceFactory.forUri(unitContext.uriStr);
       if (unitSource == null) continue;

       var unitElement = CompilationUnitElementImpl();
       unitElement.isSynthetic = unitContext.isSynthetic;
       unitElement.librarySource = librarySource;
       unitElement.lineInfo = unitNode.lineInfo;
       unitElement.source = unitSource;
       unitElement.uri = unitContext.partUriStr;
       _bindReference(unitContext.reference, unitElement);

       units.add(unitElement);
     }

     libraryElement.definingCompilationUnit = units[0];
     libraryElement.parts = units.skip(1).toList();

     return libraryElement;
   }

   LibraryElementImpl? createLibraryElementForReading(String uriStr) {
     var sourceFactory = analysisContext.sourceFactory;
     var librarySource = sourceFactory.forUri(uriStr);

     // The URI cannot be resolved, we don't know the library.
     if (librarySource == null) return null;

     var reader = libraryReaders[uriStr];
     if (reader == null) {
       throw ArgumentError(
         'Missing library: $uriStr\n'
         'Available libraries: ${libraryReaders.keys.toList()}',
       );
     }

     var libraryElement = reader.readElement(
       librarySource: librarySource,
     );
     _setLibraryTypeSystem(libraryElement);
     return libraryElement;
   }

   void createTypeProviders(
     LibraryElementImpl dartCore,
     LibraryElementImpl dartAsync,
   ) {
     if (analysisContext.hasTypeProvider) {
       return;
     }

     analysisContext.setTypeProviders(
       legacy: TypeProviderImpl(
         coreLibrary: dartCore,
         asyncLibrary: dartAsync,
         isNonNullableByDefault: false,
       ),
       nonNullableByDefault: TypeProviderImpl(
         coreLibrary: dartCore,
         asyncLibrary: dartAsync,
         isNonNullableByDefault: true,
       ),
     );

     // During linking we create libraries when typeProvider is not ready.
     // Update these libraries now, when typeProvider is ready.
     for (var reference in rootReference.children) {
       var libraryElement = reference.element as LibraryElementImpl?;
       if (libraryElement != null && !libraryElement.hasTypeProviderSystemSet) {
         _setLibraryTypeSystem(libraryElement);
       }
     }
   }

   Element? elementOfReference(Reference reference) {
     if (reference.element != null) {
       return reference.element;
     }
     if (reference.parent == null) {
       return null;
     }

     if (reference.isLibrary) {
       var uriStr = reference.name;
       return createLibraryElementForReading(uriStr);
     }

     var parent = reference.parent!.parent!;
     var parentElement = elementOfReference(parent);

     if (parentElement is ClassElementImpl) {
       var linkedData = parentElement.linkedData;
       if (linkedData is ClassElementLinkedData) {
         linkedData.readMembers(parentElement);
       }
     }

     var element = reference.element;
     if (element == null) {
       throw StateError('Expected existing element: $reference');
     }
     return element;
   }

   List<Reference> exportsOfLibrary(String uriStr) {
     var library = libraryReaders[uriStr];
     if (library == null) return const [];

     return library.exports;
   }

   bool hasLibrary(String uriStr) {
     return libraryReaders[uriStr] != null;
   }

   LibraryElementImpl? libraryOfUri(String uriStr) {
     var reference = rootReference.getChild(uriStr);
     return elementOfReference(reference) as LibraryElementImpl?;
   }

   LibraryElementImpl libraryOfUri2(String uriStr) {
     var element = libraryOfUri(uriStr);
     if (element == null) {
       throw StateError('No library: $uriStr');
     }
     return element;
   }

   /// We have linked the bundle, and need to disconnect its libraries, so
   /// that the client can re-add the bundle, this time read from bytes.
   void removeBundle(Set<String> uriStrSet) {
     removeLibraries(uriStrSet);

     // This is the bundle with dart:core and dart:async, based on full ASTs.
     // To link them, the linker set the type provider. We are removing these
     // libraries, and we should also remove the type provider.
     if (uriStrSet.contains('dart:core')) {
       if (!uriStrSet.contains('dart:async')) {
         throw StateError(
           'Expected to link dart:core and dart:async together: '
           '${uriStrSet.toList()}',
         );
       }
       if (libraryReaders.isNotEmpty) {
         throw StateError(
           'Expected to link dart:core and dart:async first: '
           '${libraryReaders.keys.toList()}',
         );
       }
       analysisContext.clearTypeProvider();
       _declareDartCoreDynamicNever();
     }
   }

   /// Remove libraries with the specified URIs from the reference tree, and
   /// any session level caches.
   void removeLibraries(Set<String> uriStrSet) {
     for (var uriStr in uriStrSet) {
       libraryReaders.remove(uriStr);
       rootReference.removeChild(uriStr);
     }

     analysisSession.classHierarchy.removeOfLibraries(uriStrSet);
     analysisSession.inheritanceManager.removeOfLibraries(uriStrSet);
   }

   void _declareDartCoreDynamicNever() {
     var dartCoreRef = rootReference.getChild('dart:core');
     dartCoreRef.getChild('dynamic').element = DynamicElementImpl.instance;
     dartCoreRef.getChild('Never').element = NeverElementImpl.instance;
   }

   void _setLibraryTypeSystem(LibraryElementImpl libraryElement) {
     // During linking we create libraries when typeProvider is not ready.
     // And if we link dart:core and dart:async, we cannot create it.
     // We will set typeProvider later, during [createTypeProviders].
     if (!analysisContext.hasTypeProvider) {
       return;
     }

     var isNonNullable = libraryElement.isNonNullableByDefault;
     libraryElement.typeProvider = isNonNullable
         ? analysisContext.typeProviderNonNullableByDefault
         : analysisContext.typeProviderLegacy;
     libraryElement.typeSystem = isNonNullable
         ? analysisContext.typeSystemNonNullableByDefault
         : analysisContext.typeSystemLegacy;
     libraryElement.hasTypeProviderSystemSet = true;

     libraryElement.createLoadLibraryFunction();
   }

   static void _bindReference(Reference reference, ElementImpl element) {
     reference.element = element;
     element.reference = reference;
   }
 }
	// Copyright (c) 2019, 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 'package:analyzer/dart/ast/ast.dart';
	import 'package:analyzer/dart/element/element.dart';
	import 'package:analyzer/src/context/context.dart';
	import 'package:analyzer/src/dart/analysis/session.dart';
	import 'package:analyzer/src/dart/element/element.dart';
	import 'package:analyzer/src/dart/element/type_provider.dart';
	import 'package:analyzer/src/dart/resolver/scope.dart';
	import 'package:analyzer/src/summary2/bundle_reader.dart';
	import 'package:analyzer/src/summary2/linked_library_context.dart';
	import 'package:analyzer/src/summary2/reference.dart';

	class LinkedElementFactory {
	final AnalysisContextImpl analysisContext;
	final AnalysisSessionImpl analysisSession;
	final Reference rootReference;
	final Map<String, LibraryReader> libraryReaders = {};

	bool isApplyingInformativeData = false;

	LinkedElementFactory(
	this.analysisContext,
	this.analysisSession,
	this.rootReference,
	) {
	ArgumentError.checkNotNull(analysisContext, 'analysisContext');
	ArgumentError.checkNotNull(analysisSession, 'analysisSession');
	_declareDartCoreDynamicNever();
	}

	Reference get dynamicRef {
	return rootReference.getChild('dart:core').getChild('dynamic');
	}

	bool get hasDartCore {
	return libraryReaders.containsKey('dart:core');
	}

	void addBundle(BundleReader bundle) {
	addLibraries(bundle.libraryMap);
	}

	void addLibraries(Map<String, LibraryReader> libraries) {
	libraryReaders.addAll(libraries);
	}

	Namespace buildExportNamespace(Uri uri) {
	var exportedNames = <String, Element>{};

	var exportedReferences = exportsOfLibrary('$uri');
	for (var exportedReference in exportedReferences) {
	var element = elementOfReference(exportedReference);
	// TODO(scheglov) Remove after https://github.com/dart-lang/sdk/issues/41212
	if (element == null) {
	throw StateError(
	'[No element]'
	'[uri: $uri]'
	'[exportedReferences: $exportedReferences]'
	'[exportedReference: $exportedReference]',
	);
	}
	exportedNames[element.name!] = element;
	}

	return Namespace(exportedNames);
	}

	LibraryElementImpl? createLibraryElementForLinking(
	LinkedLibraryContext libraryContext,
	) {
	var sourceFactory = analysisContext.sourceFactory;
	var libraryUriStr = libraryContext.uriStr;
	var librarySource = sourceFactory.forUri(libraryUriStr);

	// The URI cannot be resolved, we don't know the library.
	if (librarySource == null) return null;

	var definingUnitContext = libraryContext.definingUnit;
	var definingUnitNode = definingUnitContext.unit;

	// TODO(scheglov) Do we need this?
	var name = '';
	var nameOffset = -1;
	var nameLength = 0;
	for (var directive in definingUnitNode.directives) {
	if (directive is LibraryDirective) {
	name = directive.name.components.map((e) => e.name).join('.');
	nameOffset = directive.name.offset;
	nameLength = directive.name.length;
	break;
	}
	}

	var libraryElement = LibraryElementImpl(
	analysisContext,
	analysisSession,
	name,
	nameOffset,
	nameLength,
	definingUnitNode.featureSet,
	);
	libraryElement.isSynthetic = definingUnitContext.isSynthetic;
	libraryElement.languageVersion = definingUnitNode.languageVersion!;
	_bindReference(libraryContext.reference, libraryElement);
	_setLibraryTypeSystem(libraryElement);

	var units = <CompilationUnitElementImpl>[];
	for (var unitContext in libraryContext.units) {
	var unitNode = unitContext.unit;

	var unitSource = sourceFactory.forUri(unitContext.uriStr);
	if (unitSource == null) continue;

	var unitElement = CompilationUnitElementImpl();
	unitElement.isSynthetic = unitContext.isSynthetic;
	unitElement.librarySource = librarySource;
	unitElement.lineInfo = unitNode.lineInfo;
	unitElement.source = unitSource;
	unitElement.uri = unitContext.partUriStr;
	_bindReference(unitContext.reference, unitElement);

	units.add(unitElement);
	}

	libraryElement.definingCompilationUnit = units[0];
	libraryElement.parts = units.skip(1).toList();

	return libraryElement;
	}

	LibraryElementImpl? createLibraryElementForReading(String uriStr) {
	var sourceFactory = analysisContext.sourceFactory;
	var librarySource = sourceFactory.forUri(uriStr);

	// The URI cannot be resolved, we don't know the library.
	if (librarySource == null) return null;

	var reader = libraryReaders[uriStr];
	if (reader == null) {
	throw ArgumentError(
	'Missing library: $uriStr\n'
	'Available libraries: ${libraryReaders.keys.toList()}',
	);
	}

	var libraryElement = reader.readElement(
	librarySource: librarySource,
	);
	_setLibraryTypeSystem(libraryElement);
	return libraryElement;
	}

	void createTypeProviders(
	LibraryElementImpl dartCore,
	LibraryElementImpl dartAsync,
	) {
	if (analysisContext.hasTypeProvider) {
	return;
	}

	analysisContext.setTypeProviders(
	legacy: TypeProviderImpl(
	coreLibrary: dartCore,
	asyncLibrary: dartAsync,
	isNonNullableByDefault: false,
	),
	nonNullableByDefault: TypeProviderImpl(
	coreLibrary: dartCore,
	asyncLibrary: dartAsync,
	isNonNullableByDefault: true,
	),
	);

	// During linking we create libraries when typeProvider is not ready.
	// Update these libraries now, when typeProvider is ready.
	for (var reference in rootReference.children) {
	var libraryElement = reference.element as LibraryElementImpl?;
	if (libraryElement != null && !libraryElement.hasTypeProviderSystemSet) {
	_setLibraryTypeSystem(libraryElement);
	}
	}
	}

	Element? elementOfReference(Reference reference) {
	if (reference.element != null) {
	return reference.element;
	}
	if (reference.parent == null) {
	return null;
	}

	if (reference.isLibrary) {
	var uriStr = reference.name;
	return createLibraryElementForReading(uriStr);
	}

	var parent = reference.parent!.parent!;
	var parentElement = elementOfReference(parent);

	if (parentElement is ClassElementImpl) {
	var linkedData = parentElement.linkedData;
	if (linkedData is ClassElementLinkedData) {
	linkedData.readMembers(parentElement);
	}
	}

	var element = reference.element;
	if (element == null) {
	throw StateError('Expected existing element: $reference');
	}
	return element;
	}

	List<Reference> exportsOfLibrary(String uriStr) {
	var library = libraryReaders[uriStr];
	if (library == null) return const [];

	return library.exports;
	}

	bool hasLibrary(String uriStr) {
	return libraryReaders[uriStr] != null;
	}

	LibraryElementImpl? libraryOfUri(String uriStr) {
	var reference = rootReference.getChild(uriStr);
	return elementOfReference(reference) as LibraryElementImpl?;
	}

	LibraryElementImpl libraryOfUri2(String uriStr) {
	var element = libraryOfUri(uriStr);
	if (element == null) {
	throw StateError('No library: $uriStr');
	}
	return element;
	}

	/// We have linked the bundle, and need to disconnect its libraries, so
	/// that the client can re-add the bundle, this time read from bytes.
	void removeBundle(Set<String> uriStrSet) {
	removeLibraries(uriStrSet);

	// This is the bundle with dart:core and dart:async, based on full ASTs.
	// To link them, the linker set the type provider. We are removing these
	// libraries, and we should also remove the type provider.
	if (uriStrSet.contains('dart:core')) {
	if (!uriStrSet.contains('dart:async')) {
	throw StateError(
	'Expected to link dart:core and dart:async together: '
	'${uriStrSet.toList()}',
	);
	}
	if (libraryReaders.isNotEmpty) {
	throw StateError(
	'Expected to link dart:core and dart:async first: '
	'${libraryReaders.keys.toList()}',
	);
	}
	analysisContext.clearTypeProvider();
	_declareDartCoreDynamicNever();
	}
	}

	/// Remove libraries with the specified URIs from the reference tree, and
	/// any session level caches.
	void removeLibraries(Set<String> uriStrSet) {
	for (var uriStr in uriStrSet) {
	libraryReaders.remove(uriStr);
	rootReference.removeChild(uriStr);
	}

	analysisSession.classHierarchy.removeOfLibraries(uriStrSet);
	analysisSession.inheritanceManager.removeOfLibraries(uriStrSet);
	}

	void _declareDartCoreDynamicNever() {
	var dartCoreRef = rootReference.getChild('dart:core');
	dartCoreRef.getChild('dynamic').element = DynamicElementImpl.instance;
	dartCoreRef.getChild('Never').element = NeverElementImpl.instance;
	}

	void _setLibraryTypeSystem(LibraryElementImpl libraryElement) {
	// During linking we create libraries when typeProvider is not ready.
	// And if we link dart:core and dart:async, we cannot create it.
	// We will set typeProvider later, during [createTypeProviders].
	if (!analysisContext.hasTypeProvider) {
	return;
	}

	var isNonNullable = libraryElement.isNonNullableByDefault;
	libraryElement.typeProvider = isNonNullable
	? analysisContext.typeProviderNonNullableByDefault
	: analysisContext.typeProviderLegacy;
	libraryElement.typeSystem = isNonNullable
	? analysisContext.typeSystemNonNullableByDefault
	: analysisContext.typeSystemLegacy;
	libraryElement.hasTypeProviderSystemSet = true;

	libraryElement.createLoadLibraryFunction();
	}

	static void _bindReference(Reference reference, ElementImpl element) {
	reference.element = element;
	element.reference = reference;
	}
	}