pkg/analyzer/lib/source/embedder.dart - sdk.git - Git at Google

 // Copyright (c) 2015, 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 analyzer.source.embedder;

 import 'dart:collection' show HashMap;
 import 'dart:core' hide Resource;

 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/context/context.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/java_core.dart';
 import 'package:analyzer/src/generated/java_engine.dart';
 import 'package:analyzer/src/generated/java_io.dart' show JavaFile;
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:analyzer/src/generated/source_io.dart' show FileBasedSource;
 import 'package:yaml/yaml.dart';

 const String _DART_COLON_PREFIX = 'dart:';

 /// Given a packageMap, check in each package's lib directory for the
 /// existence of an `_embedder.yaml` file. If the file contains a top level
 /// YamlMap, it will be added to the [embedderYamls] map.
 class EmbedderYamlLocator {
   static const String EMBEDDER_FILE_NAME = '_embedder.yaml';

   // Map from package's library directory to the parsed
   // YamlMap.
   final Map<Folder, YamlMap> embedderYamls = new HashMap<Folder, YamlMap>();

   EmbedderYamlLocator(Map<String, List<Folder>> packageMap) {
     if (packageMap != null) {
       refresh(packageMap);
     }
   }

   void refresh(Map<String, List<Folder>> packageMap) {
     // Clear existing.
     embedderYamls.clear();
     if (packageMap == null) {
       return;
     }
     packageMap.forEach(_processPackage);
   }

   /// Programatically add an _embedder.yaml mapping.
   void addEmbedderYaml(Folder libDir, String embedderYaml) {
     _processEmbedderYaml(libDir, embedderYaml);
   }

   /// Given a package [name] and a list of folders ([libDirs]),
   /// add any found `_embedder.yaml` files.
   void _processPackage(String name, List<Folder> libDirs) {
     for (Folder libDir in libDirs) {
       String embedderYaml = _readEmbedderYaml(libDir);
       if (embedderYaml != null) {
         _processEmbedderYaml(libDir, embedderYaml);
       }
     }
   }

   /// Given the yaml for an embedder ([embedderYaml]) and a folder
   /// ([libDir]), setup the uri mapping.
   void _processEmbedderYaml(Folder libDir, String embedderYaml) {
     YamlNode yaml;
     try {
       yaml = loadYaml(embedderYaml);
     } catch (_) {
       // TODO(pquitslund): Notify developer that something is wrong with the
       // _embedder.yaml file in libDir.
       return;
     }
     if (yaml == null) {
       // TODO(pquitslund): Notify developer that something is wrong with the
       // _embedder.yaml file in libDir.
       return;
     }
     if (yaml is! YamlMap) {
       // TODO(pquitslund): Notify developer that something is wrong with the
       // _embedder.yaml file in libDir.
       return;
     }
     embedderYamls[libDir] = yaml;
   }

   /// Read the contents of [libDir]/[EMBEDDER_FILE_NAME] as a string.
   /// Returns null if the file doesn't exist.
   String _readEmbedderYaml(Folder libDir) {
     File file = libDir.getChild(EMBEDDER_FILE_NAME);
     try {
       return file.readAsStringSync();
     } on FileSystemException {
       // File can't be read.
       return null;
     }
   }
 }

 /// Given the [embedderYamls] from [EmbedderYamlLocator] check each one for the
 /// top level key 'embedded_libs'. Under the 'embedded_libs' key are key value
 /// pairs. Each key is a 'dart:' library uri and each value is a path
 /// (relative to the directory containing `_embedder.yaml`) to a dart script
 /// for the given library. For example:
 ///
 /// embedded_libs:
 ///   'dart:io': '../../sdk/io/io.dart'
 ///
 /// If a key doesn't begin with `dart:` it is ignored.
 ///
 class EmbedderUriResolver extends DartUriResolver {
   final Map<String, String> _urlMappings = <String, String>{};

   /// Construct a [EmbedderUriResolver] from a package map
   /// (see [PackageMapProvider]).
   EmbedderUriResolver(Map<Folder, YamlMap> embedderYamls)
       : super(new EmbedderSdk()) {
     (dartSdk as EmbedderSdk)._resolver = this;
     if (embedderYamls == null) {
       return;
     }
     embedderYamls.forEach(_processEmbedderYaml);
   }

   void _processEmbedderYaml(Folder libDir, YamlMap map) {
     YamlNode embedded_libs = map['embedded_libs'];
     if (embedded_libs == null) {
       return;
     }
     if (embedded_libs is! YamlMap) {
       return;
     }
     (embedded_libs as YamlMap)
         .forEach((k, v) => _processEmbeddedLibs(k, v, libDir));
   }

   /// Install the mapping from [name] to [libDir]/[file].
   void _processEmbeddedLibs(String name, String file, Folder libDir) {
     if (!name.startsWith(_DART_COLON_PREFIX)) {
       // SDK libraries must begin with 'dart:'.
       // TODO(pquitslund): Notify developer that something is wrong with the
       // _embedder.yaml file in libDir.
       return;
     }
     String libPath = libDir.canonicalizePath(file);
     _urlMappings[name] = libPath;
     String shortName = name.substring(_DART_COLON_PREFIX.length);
     SdkLibraryImpl library = new SdkLibraryImpl(shortName);
     library.path = libPath;
     (dartSdk as EmbedderSdk)._librariesMap.setLibrary(name, library);
   }

   /// Number of embedded libraries.
   int get length => _urlMappings.length;

   @override
   Uri restoreAbsolute(Source source) {
     String path = source.fullName;
     if (path.length > 3 && path[1] == ':' && path[2] == '\\') {
       path = '/${path[0]}:${path.substring(2).replaceAll('\\', '/')}';
     }
     Source sdkSource = dartSdk.fromFileUri(Uri.parse('file://$path'));
     return sdkSource?.uri;
   }
 }

 class EmbedderSdk implements DartSdk {
   // TODO(danrubel) Refactor this with DirectoryBasedDartSdk

   /// The resolver associated with this embedder sdk.
   EmbedderUriResolver _resolver;

   /// The [AnalysisContext] which is used for all of the sources in this sdk.
   InternalAnalysisContext _analysisContext;

   /// The library map that is populated by visiting the AST structure parsed from
   /// the contents of the libraries file.
   final LibraryMap _librariesMap = new LibraryMap();

   @override
   AnalysisContext get context {
     if (_analysisContext == null) {
       _analysisContext = new SdkAnalysisContext();
       SourceFactory factory = new SourceFactory([_resolver]);
       _analysisContext.sourceFactory = factory;
       List<String> uris = this.uris;
       ChangeSet changeSet = new ChangeSet();
       for (String uri in uris) {
         changeSet.addedSource(factory.forUri(uri));
       }
       _analysisContext.applyChanges(changeSet);
     }
     return _analysisContext;
   }

   @override
   List<SdkLibrary> get sdkLibraries => _librariesMap.sdkLibraries;

   // TODO(danrubel) Determine SDK version
   @override
   String get sdkVersion => '0';

   @override
   List<String> get uris => _librariesMap.uris;

   @override
   Source fromFileUri(Uri uri) {
     JavaFile file = new JavaFile.fromUri(uri);
     String filePath = file.getAbsolutePath();

     String path;
     for (SdkLibrary library in _librariesMap.sdkLibraries) {
       String libraryPath = library.path.replaceAll('/', JavaFile.separator);
       if (filePath == libraryPath) {
         path = '$_DART_COLON_PREFIX${library.shortName}';
         break;
       }
     }
     if (path == null) {
       for (SdkLibrary library in _librariesMap.sdkLibraries) {
         String libraryPath = library.path.replaceAll('/', JavaFile.separator);
         int index = libraryPath.lastIndexOf(JavaFile.separator);
         if (index == -1) {
           continue;
         }
         String prefix = libraryPath.substring(0, index + 1);
         if (!filePath.startsWith(prefix)) {
           continue;
         }
         var relPath = filePath
             .substring(prefix.length).replaceAll(JavaFile.separator, '/');
         path = '$_DART_COLON_PREFIX${library.shortName}/$relPath';
         break;
       }
     }

     if (path != null) {
       try {
         return new FileBasedSource(file, parseUriWithException(path));
       } on URISyntaxException catch (exception, stackTrace) {
         AnalysisEngine.instance.logger.logInformation(
             "Failed to create URI: $path",
             new CaughtException(exception, stackTrace));
         return null;
       }
     }
     return null;
   }

   @override
   SdkLibrary getSdkLibrary(String dartUri) => _librariesMap.getLibrary(dartUri);

   @override
   Source mapDartUri(String dartUri) {
     String libraryName;
     String relativePath;
     int index = dartUri.indexOf('/');
     if (index >= 0) {
       libraryName = dartUri.substring(0, index);
       relativePath = dartUri.substring(index + 1);
     } else {
       libraryName = dartUri;
       relativePath = "";
     }
     SdkLibrary library = getSdkLibrary(libraryName);
     if (library == null) {
       return null;
     }
     String srcPath;
     if (relativePath.isEmpty) {
       srcPath = library.path;
     } else {
       String libraryPath = library.path;
       int index = libraryPath.lastIndexOf(JavaFile.separator);
       if (index == -1) {
         index = libraryPath.lastIndexOf('/');
         if (index == -1) {
           return null;
         }
       }
       String prefix = libraryPath.substring(0, index + 1);
       srcPath = '$prefix$relativePath';
     }
     String filePath = srcPath.replaceAll('/', JavaFile.separator);
     try {
       JavaFile file = new JavaFile(filePath);
       return new FileBasedSource(file, parseUriWithException(dartUri));
     } on URISyntaxException {
       return null;
     }
   }
 }
	// Copyright (c) 2015, 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 analyzer.source.embedder;

	import 'dart:collection' show HashMap;
	import 'dart:core' hide Resource;

	import 'package:analyzer/file_system/file_system.dart';
	import 'package:analyzer/src/context/context.dart';
	import 'package:analyzer/src/generated/engine.dart';
	import 'package:analyzer/src/generated/java_core.dart';
	import 'package:analyzer/src/generated/java_engine.dart';
	import 'package:analyzer/src/generated/java_io.dart' show JavaFile;
	import 'package:analyzer/src/generated/sdk.dart';
	import 'package:analyzer/src/generated/source.dart';
	import 'package:analyzer/src/generated/source_io.dart' show FileBasedSource;
	import 'package:yaml/yaml.dart';

	const String _DART_COLON_PREFIX = 'dart:';

	/// Given a packageMap, check in each package's lib directory for the
	/// existence of an `_embedder.yaml` file. If the file contains a top level
	/// YamlMap, it will be added to the [embedderYamls] map.
	class EmbedderYamlLocator {
	static const String EMBEDDER_FILE_NAME = '_embedder.yaml';

	// Map from package's library directory to the parsed
	// YamlMap.
	final Map<Folder, YamlMap> embedderYamls = new HashMap<Folder, YamlMap>();

	EmbedderYamlLocator(Map<String, List<Folder>> packageMap) {
	if (packageMap != null) {
	refresh(packageMap);
	}
	}

	void refresh(Map<String, List<Folder>> packageMap) {
	// Clear existing.
	embedderYamls.clear();
	if (packageMap == null) {
	return;
	}
	packageMap.forEach(_processPackage);
	}

	/// Programatically add an _embedder.yaml mapping.
	void addEmbedderYaml(Folder libDir, String embedderYaml) {
	_processEmbedderYaml(libDir, embedderYaml);
	}

	/// Given a package [name] and a list of folders ([libDirs]),
	/// add any found `_embedder.yaml` files.
	void _processPackage(String name, List<Folder> libDirs) {
	for (Folder libDir in libDirs) {
	String embedderYaml = _readEmbedderYaml(libDir);
	if (embedderYaml != null) {
	_processEmbedderYaml(libDir, embedderYaml);
	}
	}
	}

	/// Given the yaml for an embedder ([embedderYaml]) and a folder
	/// ([libDir]), setup the uri mapping.
	void _processEmbedderYaml(Folder libDir, String embedderYaml) {
	YamlNode yaml;
	try {
	yaml = loadYaml(embedderYaml);
	} catch (_) {
	// TODO(pquitslund): Notify developer that something is wrong with the
	// _embedder.yaml file in libDir.
	return;
	}
	if (yaml == null) {
	// TODO(pquitslund): Notify developer that something is wrong with the
	// _embedder.yaml file in libDir.
	return;
	}
	if (yaml is! YamlMap) {
	// TODO(pquitslund): Notify developer that something is wrong with the
	// _embedder.yaml file in libDir.
	return;
	}
	embedderYamls[libDir] = yaml;
	}

	/// Read the contents of [libDir]/[EMBEDDER_FILE_NAME] as a string.
	/// Returns null if the file doesn't exist.
	String _readEmbedderYaml(Folder libDir) {
	File file = libDir.getChild(EMBEDDER_FILE_NAME);
	try {
	return file.readAsStringSync();
	} on FileSystemException {
	// File can't be read.
	return null;
	}
	}
	}

	/// Given the [embedderYamls] from [EmbedderYamlLocator] check each one for the
	/// top level key 'embedded_libs'. Under the 'embedded_libs' key are key value
	/// pairs. Each key is a 'dart:' library uri and each value is a path
	/// (relative to the directory containing `_embedder.yaml`) to a dart script
	/// for the given library. For example:
	///
	/// embedded_libs:
	/// 'dart:io': '../../sdk/io/io.dart'
	///
	/// If a key doesn't begin with `dart:` it is ignored.
	///
	class EmbedderUriResolver extends DartUriResolver {
	final Map<String, String> _urlMappings = <String, String>{};

	/// Construct a [EmbedderUriResolver] from a package map
	/// (see [PackageMapProvider]).
	EmbedderUriResolver(Map<Folder, YamlMap> embedderYamls)
	: super(new EmbedderSdk()) {
	(dartSdk as EmbedderSdk)._resolver = this;
	if (embedderYamls == null) {
	return;
	}
	embedderYamls.forEach(_processEmbedderYaml);
	}

	void _processEmbedderYaml(Folder libDir, YamlMap map) {
	YamlNode embedded_libs = map['embedded_libs'];
	if (embedded_libs == null) {
	return;
	}
	if (embedded_libs is! YamlMap) {
	return;
	}
	(embedded_libs as YamlMap)
	.forEach((k, v) => _processEmbeddedLibs(k, v, libDir));
	}

	/// Install the mapping from [name] to [libDir]/[file].
	void _processEmbeddedLibs(String name, String file, Folder libDir) {
	if (!name.startsWith(_DART_COLON_PREFIX)) {
	// SDK libraries must begin with 'dart:'.
	// TODO(pquitslund): Notify developer that something is wrong with the
	// _embedder.yaml file in libDir.
	return;
	}
	String libPath = libDir.canonicalizePath(file);
	_urlMappings[name] = libPath;
	String shortName = name.substring(_DART_COLON_PREFIX.length);
	SdkLibraryImpl library = new SdkLibraryImpl(shortName);
	library.path = libPath;
	(dartSdk as EmbedderSdk)._librariesMap.setLibrary(name, library);
	}

	/// Number of embedded libraries.
	int get length => _urlMappings.length;

	@override
	Uri restoreAbsolute(Source source) {
	String path = source.fullName;
	if (path.length > 3 && path[1] == ':' && path[2] == '\\') {
	path = '/${path[0]}:${path.substring(2).replaceAll('\\', '/')}';
	}
	Source sdkSource = dartSdk.fromFileUri(Uri.parse('file://$path'));
	return sdkSource?.uri;
	}
	}

	class EmbedderSdk implements DartSdk {
	// TODO(danrubel) Refactor this with DirectoryBasedDartSdk

	/// The resolver associated with this embedder sdk.
	EmbedderUriResolver _resolver;

	/// The [AnalysisContext] which is used for all of the sources in this sdk.
	InternalAnalysisContext _analysisContext;

	/// The library map that is populated by visiting the AST structure parsed from
	/// the contents of the libraries file.
	final LibraryMap _librariesMap = new LibraryMap();

	@override
	AnalysisContext get context {
	if (_analysisContext == null) {
	_analysisContext = new SdkAnalysisContext();
	SourceFactory factory = new SourceFactory([_resolver]);
	_analysisContext.sourceFactory = factory;
	List<String> uris = this.uris;
	ChangeSet changeSet = new ChangeSet();
	for (String uri in uris) {
	changeSet.addedSource(factory.forUri(uri));
	}
	_analysisContext.applyChanges(changeSet);
	}
	return _analysisContext;
	}

	@override
	List<SdkLibrary> get sdkLibraries => _librariesMap.sdkLibraries;

	// TODO(danrubel) Determine SDK version
	@override
	String get sdkVersion => '0';

	@override
	List<String> get uris => _librariesMap.uris;

	@override
	Source fromFileUri(Uri uri) {
	JavaFile file = new JavaFile.fromUri(uri);
	String filePath = file.getAbsolutePath();

	String path;
	for (SdkLibrary library in _librariesMap.sdkLibraries) {
	String libraryPath = library.path.replaceAll('/', JavaFile.separator);
	if (filePath == libraryPath) {
	path = '$_DART_COLON_PREFIX${library.shortName}';
	break;
	}
	}
	if (path == null) {
	for (SdkLibrary library in _librariesMap.sdkLibraries) {
	String libraryPath = library.path.replaceAll('/', JavaFile.separator);
	int index = libraryPath.lastIndexOf(JavaFile.separator);
	if (index == -1) {
	continue;
	}
	String prefix = libraryPath.substring(0, index + 1);
	if (!filePath.startsWith(prefix)) {
	continue;
	}
	var relPath = filePath
	.substring(prefix.length).replaceAll(JavaFile.separator, '/');
	path = '$_DART_COLON_PREFIX${library.shortName}/$relPath';
	break;
	}
	}

	if (path != null) {
	try {
	return new FileBasedSource(file, parseUriWithException(path));
	} on URISyntaxException catch (exception, stackTrace) {
	AnalysisEngine.instance.logger.logInformation(
	"Failed to create URI: $path",
	new CaughtException(exception, stackTrace));
	return null;
	}
	}
	return null;
	}

	@override
	SdkLibrary getSdkLibrary(String dartUri) => _librariesMap.getLibrary(dartUri);

	@override
	Source mapDartUri(String dartUri) {
	String libraryName;
	String relativePath;
	int index = dartUri.indexOf('/');
	if (index >= 0) {
	libraryName = dartUri.substring(0, index);
	relativePath = dartUri.substring(index + 1);
	} else {
	libraryName = dartUri;
	relativePath = "";
	}
	SdkLibrary library = getSdkLibrary(libraryName);
	if (library == null) {
	return null;
	}
	String srcPath;
	if (relativePath.isEmpty) {
	srcPath = library.path;
	} else {
	String libraryPath = library.path;
	int index = libraryPath.lastIndexOf(JavaFile.separator);
	if (index == -1) {
	index = libraryPath.lastIndexOf('/');
	if (index == -1) {
	return null;
	}
	}
	String prefix = libraryPath.substring(0, index + 1);
	srcPath = '$prefix$relativePath';
	}
	String filePath = srcPath.replaceAll('/', JavaFile.separator);
	try {
	JavaFile file = new JavaFile(filePath);
	return new FileBasedSource(file, parseUriWithException(dartUri));
	} on URISyntaxException {
	return null;
	}
	}
	}