pkg/analyzer_cli/lib/src/analyzer_impl.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_cli.src.analyzer_impl;

 import 'dart:async';
 import 'dart:collection';
 import 'dart:io';

 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/exception/exception.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart';
 import 'package:analyzer/src/generated/engine.dart' hide AnalysisResult;
 import 'package:analyzer/src/generated/java_io.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:analyzer/src/generated/source_io.dart';
 import 'package:analyzer/src/generated/utilities_general.dart';
 import 'package:analyzer_cli/src/driver.dart';
 import 'package:analyzer_cli/src/error_formatter.dart';
 import 'package:analyzer_cli/src/error_severity.dart';
 import 'package:analyzer_cli/src/options.dart';
 import 'package:path/path.dart' as path;

 int get currentTimeMillis => new DateTime.now().millisecondsSinceEpoch;

 /// Analyzes single library [File].
 class AnalyzerImpl {
   static final PerformanceTag _prepareErrorsTag =
       new PerformanceTag("AnalyzerImpl.prepareErrors");
   static final PerformanceTag _resolveLibraryTag =
       new PerformanceTag("AnalyzerImpl._resolveLibrary");

   final CommandLineOptions options;
   final int startTime;

   final AnalysisOptions analysisOptions;
   final AnalysisContext context;
   final AnalysisDriver analysisDriver;

   /// Accumulated analysis statistics.
   final AnalysisStats stats;

   final Source librarySource;

   /// All [Source]s references by the analyzed library.
   final Set<Source> sources = new Set<Source>();

   /// All [AnalysisErrorInfo]s in the analyzed library.
   final List<AnalysisErrorInfo> errorInfos = new List<AnalysisErrorInfo>();

   /// [HashMap] between sources and analysis error infos.
   final HashMap<Source, AnalysisErrorInfo> sourceErrorsMap =
       new HashMap<Source, AnalysisErrorInfo>();

   /// If the file specified on the command line is part of a package, the name
   /// of that package.  Otherwise `null`.  This allows us to analyze the file
   /// specified on the command line as though it is reached via a "package:"
   /// URI, but avoid suppressing its output in the event that the user has not
   /// specified the "--package-warnings" option.
   String _selfPackageName;

   AnalyzerImpl(this.analysisOptions, this.context, this.analysisDriver,
       this.librarySource, this.options, this.stats, this.startTime);

   /// Returns the maximal [ErrorSeverity] of the recorded errors.
   ErrorSeverity get maxErrorSeverity {
     ErrorSeverity status = ErrorSeverity.NONE;
     for (AnalysisErrorInfo errorInfo in errorInfos) {
       for (AnalysisError error in errorInfo.errors) {
         if (_defaultSeverityProcessor(error) == null) {
           continue;
         }
         ErrorSeverity severity = computeSeverity(error, options);
         status = status.max(severity);
       }
     }
     return status;
   }

   void addCompilationUnitSource(
       CompilationUnitElement unit, Set<CompilationUnitElement> units) {
     if (unit == null || !units.add(unit)) {
       return;
     }
     Source source = unit.source;
     if (source != null) {
       sources.add(source);
     }
   }

   void addLibrarySources(LibraryElement library, Set<LibraryElement> libraries,
       Set<CompilationUnitElement> units) {
     if (library == null || !libraries.add(library)) {
       return;
     }
     // Maybe skip library.
     if (!_isAnalyzedLibrary(library)) {
       return;
     }
     // Add compilation units.
     addCompilationUnitSource(library.definingCompilationUnit, units);
     for (CompilationUnitElement child in library.parts) {
       addCompilationUnitSource(child, units);
     }
     // Add referenced libraries.
     for (LibraryElement child in library.importedLibraries) {
       addLibrarySources(child, libraries, units);
     }
     for (LibraryElement child in library.exportedLibraries) {
       addLibrarySources(child, libraries, units);
     }
   }

   /// Treats the [sourcePath] as the top level library and analyzes it using
   /// the analysis engine. If [printMode] is `0`, then no error or performance
   /// information is printed. If [printMode] is `1`, then errors will be printed.
   /// If [printMode] is `2`, then performance information will be printed, and
   /// it will be marked as being for a cold VM.
   Future<ErrorSeverity> analyze(ErrorFormatter formatter,
       {int printMode: 1}) async {
     setupForAnalysis();
     return await _analyze(printMode, formatter);
   }

   /// Fills [errorInfos] using [sources].
   Future<Null> prepareErrors() async {
     PerformanceTag previous = _prepareErrorsTag.makeCurrent();
     try {
       for (Source source in sources) {
         if (analysisDriver != null) {
           String path = source.fullName;
           ErrorsResult errorsResult = await analysisDriver.getErrors(path);
           errorInfos.add(new AnalysisErrorInfoImpl(
               errorsResult.errors, errorsResult.lineInfo));
         } else {
           context.computeErrors(source);
           errorInfos.add(context.getErrors(source));
         }
       }
     } finally {
       previous.makeCurrent();
     }
   }

   /// Fills [sources].
   void prepareSources(LibraryElement library) {
     var units = new Set<CompilationUnitElement>();
     var libraries = new Set<LibraryElement>();
     addLibrarySources(library, libraries, units);
   }

   /// Setup local fields such as the analysis context for analysis.
   void setupForAnalysis() {
     sources.clear();
     errorInfos.clear();
     Uri libraryUri = librarySource.uri;
     if (libraryUri.scheme == 'package' && libraryUri.pathSegments.length > 0) {
       _selfPackageName = libraryUri.pathSegments[0];
     }
   }

   Future<ErrorSeverity> _analyze(
       int printMode, ErrorFormatter formatter) async {
     // Don't try to analyze parts.
     String path = librarySource.fullName;
     SourceKind librarySourceKind = analysisDriver != null
         ? await analysisDriver.getSourceKind(path)
         : context.computeKindOf(librarySource);
     if (librarySourceKind == SourceKind.PART) {
       stderr.writeln("Only libraries can be analyzed.");
       stderr.writeln("${path} is a part and can not be analyzed.");
       return ErrorSeverity.ERROR;
     }

     LibraryElement libraryElement = await _resolveLibrary();
     prepareSources(libraryElement);
     await prepareErrors();

     // Print errors and performance numbers.
     if (printMode == 1) {
       formatter.formatErrors(errorInfos);
     } else if (printMode == 2) {
       _printColdPerf();
     }

     // Compute max severity and set exitCode.
     ErrorSeverity status = maxErrorSeverity;
     if (status == ErrorSeverity.WARNING && options.warningsAreFatal) {
       status = ErrorSeverity.ERROR;
     }
     return status;
   }

   /// Returns true if we want to report diagnostics for this library.
   bool _isAnalyzedLibrary(LibraryElement library) {
     Source source = library.source;
     switch (source.uriKind) {
       case UriKind.DART_URI:
         return options.showSdkWarnings;
       case UriKind.PACKAGE_URI:
         if (_isPathInPubCache(source.fullName)) {
           return false;
         }
         return _isAnalyzedPackage(source.uri);
       default:
         return true;
     }
   }

   /// Determine whether the given URI refers to a package being analyzed.
   bool _isAnalyzedPackage(Uri uri) {
     if (uri.scheme != 'package' || uri.pathSegments.isEmpty) {
       return false;
     }
     String packageName = uri.pathSegments.first;
     if (packageName == _selfPackageName) {
       return true;
     } else if (!options.showPackageWarnings) {
       return false;
     } else if (options.showPackageWarningsPrefix == null) {
       return true;
     } else {
       return packageName.startsWith(options.showPackageWarningsPrefix);
     }
   }

   // TODO(devoncarew): This is never called.
   void _printColdPerf() {
     // Print cold VM performance numbers.
     int totalTime = currentTimeMillis - startTime;
     int otherTime = totalTime;
     for (PerformanceTag tag in PerformanceTag.all) {
       if (tag != PerformanceTag.UNKNOWN) {
         int tagTime = tag.elapsedMs;
         outSink.writeln('${tag.label}-cold:$tagTime');
         otherTime -= tagTime;
       }
     }
     outSink.writeln('other-cold:$otherTime');
     outSink.writeln("total-cold:$totalTime");
   }

   ProcessedSeverity _defaultSeverityProcessor(AnalysisError error) =>
       determineProcessedSeverity(error, options, analysisOptions);

   Future<LibraryElement> _resolveLibrary() async {
     PerformanceTag previous = _resolveLibraryTag.makeCurrent();
     try {
       if (analysisDriver != null) {
         String path = librarySource.fullName;
         analysisDriver.priorityFiles = [path];
         UnitElementResult elementResult =
             await analysisDriver.getUnitElement(path);
         return elementResult.element.library;
       } else {
         return context.computeLibraryElement(librarySource);
       }
     } finally {
       previous.makeCurrent();
     }
   }

   /// Return the corresponding package directory or `null` if none is found.
   static JavaFile getPackageDirectoryFor(JavaFile sourceFile) {
     // We are going to ask parent file, so get absolute path.
     sourceFile = sourceFile.getAbsoluteFile();
     // Look in the containing directories.
     JavaFile dir = sourceFile.getParentFile();
     while (dir != null) {
       JavaFile packagesDir = new JavaFile.relative(dir, "packages");
       if (packagesDir.exists()) {
         return packagesDir;
       }
       dir = dir.getParentFile();
     }
     // Not found.
     return null;
   }

   /// Return `true` if the given [pathName] is in the Pub cache.
   static bool _isPathInPubCache(String pathName) {
     List<String> parts = path.split(pathName);
     if (parts.contains('.pub-cache')) {
       return true;
     }
     for (int i = 0; i < parts.length - 2; i++) {
       if (parts[i] == 'Pub' && parts[i + 1] == 'Cache') {
         return true;
       }
     }
     return false;
   }
 }

 /// This [Logger] prints out information comments to [outSink] and error messages
 /// to [errorSink].
 class StdLogger extends Logger {
   StdLogger();

   @override
   void logError(String message, [CaughtException exception]) {
     errorSink.writeln(message);
     if (exception != null) {
       errorSink.writeln(exception);
     }
   }

   @override
   void logInformation(String message, [CaughtException exception]) {
     outSink.writeln(message);
     if (exception != null) {
       outSink.writeln(exception);
     }
   }
 }
	// 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_cli.src.analyzer_impl;

	import 'dart:async';
	import 'dart:collection';
	import 'dart:io';

	import 'package:analyzer/dart/element/element.dart';
	import 'package:analyzer/error/error.dart';
	import 'package:analyzer/exception/exception.dart';
	import 'package:analyzer/src/dart/analysis/driver.dart';
	import 'package:analyzer/src/generated/engine.dart' hide AnalysisResult;
	import 'package:analyzer/src/generated/java_io.dart';
	import 'package:analyzer/src/generated/source.dart';
	import 'package:analyzer/src/generated/source_io.dart';
	import 'package:analyzer/src/generated/utilities_general.dart';
	import 'package:analyzer_cli/src/driver.dart';
	import 'package:analyzer_cli/src/error_formatter.dart';
	import 'package:analyzer_cli/src/error_severity.dart';
	import 'package:analyzer_cli/src/options.dart';
	import 'package:path/path.dart' as path;

	int get currentTimeMillis => new DateTime.now().millisecondsSinceEpoch;

	/// Analyzes single library [File].
	class AnalyzerImpl {
	static final PerformanceTag _prepareErrorsTag =
	new PerformanceTag("AnalyzerImpl.prepareErrors");
	static final PerformanceTag _resolveLibraryTag =
	new PerformanceTag("AnalyzerImpl._resolveLibrary");

	final CommandLineOptions options;
	final int startTime;

	final AnalysisOptions analysisOptions;
	final AnalysisContext context;
	final AnalysisDriver analysisDriver;

	/// Accumulated analysis statistics.
	final AnalysisStats stats;

	final Source librarySource;

	/// All [Source]s references by the analyzed library.
	final Set<Source> sources = new Set<Source>();

	/// All [AnalysisErrorInfo]s in the analyzed library.
	final List<AnalysisErrorInfo> errorInfos = new List<AnalysisErrorInfo>();

	/// [HashMap] between sources and analysis error infos.
	final HashMap<Source, AnalysisErrorInfo> sourceErrorsMap =
	new HashMap<Source, AnalysisErrorInfo>();

	/// If the file specified on the command line is part of a package, the name
	/// of that package. Otherwise `null`. This allows us to analyze the file
	/// specified on the command line as though it is reached via a "package:"
	/// URI, but avoid suppressing its output in the event that the user has not
	/// specified the "--package-warnings" option.
	String _selfPackageName;

	AnalyzerImpl(this.analysisOptions, this.context, this.analysisDriver,
	this.librarySource, this.options, this.stats, this.startTime);

	/// Returns the maximal [ErrorSeverity] of the recorded errors.
	ErrorSeverity get maxErrorSeverity {
	ErrorSeverity status = ErrorSeverity.NONE;
	for (AnalysisErrorInfo errorInfo in errorInfos) {
	for (AnalysisError error in errorInfo.errors) {
	if (_defaultSeverityProcessor(error) == null) {
	continue;
	}
	ErrorSeverity severity = computeSeverity(error, options);
	status = status.max(severity);
	}
	}
	return status;
	}

	void addCompilationUnitSource(
	CompilationUnitElement unit, Set<CompilationUnitElement> units) {
	if (unit == null \|\| !units.add(unit)) {
	return;
	}
	Source source = unit.source;
	if (source != null) {
	sources.add(source);
	}
	}

	void addLibrarySources(LibraryElement library, Set<LibraryElement> libraries,
	Set<CompilationUnitElement> units) {
	if (library == null \|\| !libraries.add(library)) {
	return;
	}
	// Maybe skip library.
	if (!_isAnalyzedLibrary(library)) {
	return;
	}
	// Add compilation units.
	addCompilationUnitSource(library.definingCompilationUnit, units);
	for (CompilationUnitElement child in library.parts) {
	addCompilationUnitSource(child, units);
	}
	// Add referenced libraries.
	for (LibraryElement child in library.importedLibraries) {
	addLibrarySources(child, libraries, units);
	}
	for (LibraryElement child in library.exportedLibraries) {
	addLibrarySources(child, libraries, units);
	}
	}

	/// Treats the [sourcePath] as the top level library and analyzes it using
	/// the analysis engine. If [printMode] is `0`, then no error or performance
	/// information is printed. If [printMode] is `1`, then errors will be printed.
	/// If [printMode] is `2`, then performance information will be printed, and
	/// it will be marked as being for a cold VM.
	Future<ErrorSeverity> analyze(ErrorFormatter formatter,
	{int printMode: 1}) async {
	setupForAnalysis();
	return await _analyze(printMode, formatter);
	}

	/// Fills [errorInfos] using [sources].
	Future<Null> prepareErrors() async {
	PerformanceTag previous = _prepareErrorsTag.makeCurrent();
	try {
	for (Source source in sources) {
	if (analysisDriver != null) {
	String path = source.fullName;
	ErrorsResult errorsResult = await analysisDriver.getErrors(path);
	errorInfos.add(new AnalysisErrorInfoImpl(
	errorsResult.errors, errorsResult.lineInfo));
	} else {
	context.computeErrors(source);
	errorInfos.add(context.getErrors(source));
	}
	}
	} finally {
	previous.makeCurrent();
	}
	}

	/// Fills [sources].
	void prepareSources(LibraryElement library) {
	var units = new Set<CompilationUnitElement>();
	var libraries = new Set<LibraryElement>();
	addLibrarySources(library, libraries, units);
	}

	/// Setup local fields such as the analysis context for analysis.
	void setupForAnalysis() {
	sources.clear();
	errorInfos.clear();
	Uri libraryUri = librarySource.uri;
	if (libraryUri.scheme == 'package' && libraryUri.pathSegments.length > 0) {
	_selfPackageName = libraryUri.pathSegments[0];
	}
	}

	Future<ErrorSeverity> _analyze(
	int printMode, ErrorFormatter formatter) async {
	// Don't try to analyze parts.
	String path = librarySource.fullName;
	SourceKind librarySourceKind = analysisDriver != null
	? await analysisDriver.getSourceKind(path)
	: context.computeKindOf(librarySource);
	if (librarySourceKind == SourceKind.PART) {
	stderr.writeln("Only libraries can be analyzed.");
	stderr.writeln("${path} is a part and can not be analyzed.");
	return ErrorSeverity.ERROR;
	}

	LibraryElement libraryElement = await _resolveLibrary();
	prepareSources(libraryElement);
	await prepareErrors();

	// Print errors and performance numbers.
	if (printMode == 1) {
	formatter.formatErrors(errorInfos);
	} else if (printMode == 2) {
	_printColdPerf();
	}

	// Compute max severity and set exitCode.
	ErrorSeverity status = maxErrorSeverity;
	if (status == ErrorSeverity.WARNING && options.warningsAreFatal) {
	status = ErrorSeverity.ERROR;
	}
	return status;
	}

	/// Returns true if we want to report diagnostics for this library.
	bool _isAnalyzedLibrary(LibraryElement library) {
	Source source = library.source;
	switch (source.uriKind) {
	case UriKind.DART_URI:
	return options.showSdkWarnings;
	case UriKind.PACKAGE_URI:
	if (_isPathInPubCache(source.fullName)) {
	return false;
	}
	return _isAnalyzedPackage(source.uri);
	default:
	return true;
	}
	}

	/// Determine whether the given URI refers to a package being analyzed.
	bool _isAnalyzedPackage(Uri uri) {
	if (uri.scheme != 'package' \|\| uri.pathSegments.isEmpty) {
	return false;
	}
	String packageName = uri.pathSegments.first;
	if (packageName == _selfPackageName) {
	return true;
	} else if (!options.showPackageWarnings) {
	return false;
	} else if (options.showPackageWarningsPrefix == null) {
	return true;
	} else {
	return packageName.startsWith(options.showPackageWarningsPrefix);
	}
	}

	// TODO(devoncarew): This is never called.
	void _printColdPerf() {
	// Print cold VM performance numbers.
	int totalTime = currentTimeMillis - startTime;
	int otherTime = totalTime;
	for (PerformanceTag tag in PerformanceTag.all) {
	if (tag != PerformanceTag.UNKNOWN) {
	int tagTime = tag.elapsedMs;
	outSink.writeln('${tag.label}-cold:$tagTime');
	otherTime -= tagTime;
	}
	}
	outSink.writeln('other-cold:$otherTime');
	outSink.writeln("total-cold:$totalTime");
	}

	ProcessedSeverity _defaultSeverityProcessor(AnalysisError error) =>
	determineProcessedSeverity(error, options, analysisOptions);

	Future<LibraryElement> _resolveLibrary() async {
	PerformanceTag previous = _resolveLibraryTag.makeCurrent();
	try {
	if (analysisDriver != null) {
	String path = librarySource.fullName;
	analysisDriver.priorityFiles = [path];
	UnitElementResult elementResult =
	await analysisDriver.getUnitElement(path);
	return elementResult.element.library;
	} else {
	return context.computeLibraryElement(librarySource);
	}
	} finally {
	previous.makeCurrent();
	}
	}

	/// Return the corresponding package directory or `null` if none is found.
	static JavaFile getPackageDirectoryFor(JavaFile sourceFile) {
	// We are going to ask parent file, so get absolute path.
	sourceFile = sourceFile.getAbsoluteFile();
	// Look in the containing directories.
	JavaFile dir = sourceFile.getParentFile();
	while (dir != null) {
	JavaFile packagesDir = new JavaFile.relative(dir, "packages");
	if (packagesDir.exists()) {
	return packagesDir;
	}
	dir = dir.getParentFile();
	}
	// Not found.
	return null;
	}

	/// Return `true` if the given [pathName] is in the Pub cache.
	static bool _isPathInPubCache(String pathName) {
	List<String> parts = path.split(pathName);
	if (parts.contains('.pub-cache')) {
	return true;
	}
	for (int i = 0; i < parts.length - 2; i++) {
	if (parts[i] == 'Pub' && parts[i + 1] == 'Cache') {
	return true;
	}
	}
	return false;
	}
	}

	/// This [Logger] prints out information comments to [outSink] and error messages
	/// to [errorSink].
	class StdLogger extends Logger {
	StdLogger();

	@override
	void logError(String message, [CaughtException exception]) {
	errorSink.writeln(message);
	if (exception != null) {
	errorSink.writeln(exception);
	}
	}

	@override
	void logInformation(String message, [CaughtException exception]) {
	outSink.writeln(message);
	if (exception != null) {
	outSink.writeln(exception);
	}
	}
	}