| /* |
| * Copyright (C) 2018 The Dagger Authors. |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package dagger.internal.codegen.validation; |
| |
| import static com.google.common.collect.Lists.asList; |
| import static dagger.internal.codegen.base.ElementFormatter.elementToString; |
| import static dagger.internal.codegen.langmodel.DaggerElements.elementEncloses; |
| import static javax.tools.Diagnostic.Kind.ERROR; |
| |
| import com.google.common.collect.ImmutableSet; |
| import com.google.errorprone.annotations.FormatMethod; |
| import dagger.model.BindingGraph; |
| import dagger.model.BindingGraph.ChildFactoryMethodEdge; |
| import dagger.model.BindingGraph.ComponentNode; |
| import dagger.model.BindingGraph.DependencyEdge; |
| import dagger.model.BindingGraph.MaybeBinding; |
| import dagger.spi.BindingGraphPlugin; |
| import dagger.spi.DiagnosticReporter; |
| import javax.annotation.processing.Messager; |
| import javax.inject.Inject; |
| import javax.lang.model.element.Element; |
| import javax.lang.model.element.TypeElement; |
| import javax.tools.Diagnostic; |
| import org.checkerframework.checker.nullness.compatqual.NullableDecl; |
| |
| /** A factory for {@link DiagnosticReporter}s. */ |
| // TODO(ronshapiro): If multiple plugins print errors on the same node/edge, should we condense the |
| // messages and only print the dependency trace once? |
| final class DiagnosticReporterFactory { |
| private final Messager messager; |
| private final DiagnosticMessageGenerator.Factory diagnosticMessageGeneratorFactory; |
| |
| @Inject |
| DiagnosticReporterFactory( |
| Messager messager, DiagnosticMessageGenerator.Factory diagnosticMessageGeneratorFactory) { |
| this.messager = messager; |
| this.diagnosticMessageGeneratorFactory = diagnosticMessageGeneratorFactory; |
| } |
| |
| /** Creates a reporter for a binding graph and a plugin. */ |
| DiagnosticReporterImpl reporter( |
| BindingGraph graph, BindingGraphPlugin plugin, boolean reportErrorsAsWarnings) { |
| return new DiagnosticReporterImpl(graph, plugin.pluginName(), reportErrorsAsWarnings); |
| } |
| |
| /** |
| * A {@link DiagnosticReporter} that keeps track of which {@linkplain Diagnostic.Kind kinds} of |
| * diagnostics were reported. |
| */ |
| final class DiagnosticReporterImpl implements DiagnosticReporter { |
| private final String plugin; |
| private final TypeElement rootComponent; |
| private final boolean reportErrorsAsWarnings; |
| private final ImmutableSet.Builder<Diagnostic.Kind> reportedDiagnosticKinds = |
| ImmutableSet.builder(); |
| private final DiagnosticMessageGenerator diagnosticMessageGenerator; |
| |
| DiagnosticReporterImpl(BindingGraph graph, String plugin, boolean reportErrorsAsWarnings) { |
| this.plugin = plugin; |
| this.reportErrorsAsWarnings = reportErrorsAsWarnings; |
| this.rootComponent = graph.rootComponentNode().componentPath().currentComponent(); |
| this.diagnosticMessageGenerator = diagnosticMessageGeneratorFactory.create(graph); |
| } |
| |
| /** Returns which {@linkplain Diagnostic.Kind kinds} of diagnostics were reported. */ |
| ImmutableSet<Diagnostic.Kind> reportedDiagnosticKinds() { |
| return reportedDiagnosticKinds.build(); |
| } |
| |
| @Override |
| public void reportComponent( |
| Diagnostic.Kind diagnosticKind, ComponentNode componentNode, String messageFormat) { |
| StringBuilder message = new StringBuilder(messageFormat); |
| diagnosticMessageGenerator.appendComponentPathUnlessAtRoot(message, componentNode); |
| // TODO(dpb): Report at the component node component. |
| printMessage(diagnosticKind, message, rootComponent); |
| } |
| |
| @Override |
| @FormatMethod |
| public void reportComponent( |
| Diagnostic.Kind diagnosticKind, |
| ComponentNode componentNode, |
| String messageFormat, |
| Object firstArg, |
| Object... moreArgs) { |
| reportComponent( |
| diagnosticKind, componentNode, formatMessage(messageFormat, firstArg, moreArgs)); |
| } |
| |
| // TODO(ronshapiro): should this also include the binding element? |
| @Override |
| public void reportBinding( |
| Diagnostic.Kind diagnosticKind, MaybeBinding binding, String message) { |
| printMessage( |
| diagnosticKind, message + diagnosticMessageGenerator.getMessage(binding), rootComponent); |
| } |
| |
| @Override |
| public void reportBinding( |
| Diagnostic.Kind diagnosticKind, |
| MaybeBinding binding, |
| String messageFormat, |
| Object firstArg, |
| Object... moreArgs) { |
| reportBinding(diagnosticKind, binding, formatMessage(messageFormat, firstArg, moreArgs)); |
| } |
| |
| @Override |
| public void reportDependency( |
| Diagnostic.Kind diagnosticKind, DependencyEdge dependencyEdge, String message) { |
| printMessage( |
| diagnosticKind, |
| message + diagnosticMessageGenerator.getMessage(dependencyEdge), |
| rootComponent); |
| } |
| |
| @Override |
| public void reportDependency( |
| Diagnostic.Kind diagnosticKind, |
| DependencyEdge dependencyEdge, |
| String messageFormat, |
| Object firstArg, |
| Object... moreArgs) { |
| reportDependency( |
| diagnosticKind, dependencyEdge, formatMessage(messageFormat, firstArg, moreArgs)); |
| } |
| |
| @Override |
| public void reportSubcomponentFactoryMethod( |
| Diagnostic.Kind diagnosticKind, |
| ChildFactoryMethodEdge childFactoryMethodEdge, |
| String message) { |
| printMessage(diagnosticKind, message, childFactoryMethodEdge.factoryMethod()); |
| } |
| |
| @Override |
| public void reportSubcomponentFactoryMethod( |
| Diagnostic.Kind diagnosticKind, |
| ChildFactoryMethodEdge childFactoryMethodEdge, |
| String messageFormat, |
| Object firstArg, |
| Object... moreArgs) { |
| reportSubcomponentFactoryMethod( |
| diagnosticKind, childFactoryMethodEdge, formatMessage(messageFormat, firstArg, moreArgs)); |
| } |
| |
| private String formatMessage(String messageFormat, Object firstArg, Object[] moreArgs) { |
| return String.format(messageFormat, asList(firstArg, moreArgs).toArray()); |
| } |
| |
| void printMessage( |
| Diagnostic.Kind diagnosticKind, |
| CharSequence message, |
| @NullableDecl Element elementToReport) { |
| if (diagnosticKind.equals(ERROR) && reportErrorsAsWarnings) { |
| diagnosticKind = Diagnostic.Kind.WARNING; |
| } |
| reportedDiagnosticKinds.add(diagnosticKind); |
| StringBuilder fullMessage = new StringBuilder(); |
| appendBracketPrefix(fullMessage, plugin); |
| |
| // TODO(ronshapiro): should we create a HashSet out of elementEncloses() so we don't |
| // need to do an O(n) contains() each time? |
| if (elementToReport != null && !elementEncloses(rootComponent, elementToReport)) { |
| appendBracketPrefix(fullMessage, elementToString(elementToReport)); |
| elementToReport = rootComponent; |
| } |
| |
| messager.printMessage(diagnosticKind, fullMessage.append(message), elementToReport); |
| } |
| |
| private void appendBracketPrefix(StringBuilder message, String prefix) { |
| message.append(String.format("[%s] ", prefix)); |
| } |
| } |
| } |