1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* Copyright (C) 2019 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.hilt.processor.internal;
import com.google.auto.common.MoreElements;
import com.google.auto.value.AutoValue;
import com.google.common.base.Throwables;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import javax.annotation.processing.Messager;
import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.Element;
import javax.lang.model.util.Elements;
import javax.tools.Diagnostic.Kind;
/** Utility class to handle keeping track of errors during processing. */
final class ProcessorErrorHandler {
private static final String FAILURE_PREFIX = "[Hilt]\n";
// Special characters to make the tag red and bold to draw attention since
// this error can get drowned out by other errors resulting from missing
// symbols when we can't generate code.
private static final String FAILURE_SUFFIX =
"\n\033[1;31m[Hilt] Processing did not complete. See error above for details.\033[0m";
private final Messager messager;
private final Elements elements;
private final List<HiltError> hiltErrors;
ProcessorErrorHandler(ProcessingEnvironment env) {
this.messager = env.getMessager();
this.elements = env.getElementUtils();
this.hiltErrors = new ArrayList<>();
}
/**
* Records an error message for some exception to the messager. This can be used to handle
* exceptions gracefully that would otherwise be propagated out of the {@code process} method. The
* message is stored in order to allow the build to continue as far as it can. The build will be
* failed with a {@link Kind#ERROR} in {@link #checkErrors} if an error was recorded with this
* method.
*/
void recordError(Throwable t) {
// Store messages to allow the build to continue as far as it can. The build will
// be failed in checkErrors when processing is over.
if (t instanceof BadInputException) {
BadInputException badInput = (BadInputException) t;
for (Element element : badInput.getBadElements()) {
hiltErrors.add(HiltError.of(badInput.getMessage(), element));
}
} else if (t instanceof ErrorTypeException) {
ErrorTypeException badInput = (ErrorTypeException) t;
hiltErrors.add(HiltError.of(badInput.getMessage(), badInput.getBadElement()));
} else if (t.getMessage() != null) {
hiltErrors.add(HiltError.of(t.getMessage() + ": " + Throwables.getStackTraceAsString(t)));
} else {
hiltErrors.add(HiltError.of(t.getClass() + ": " + Throwables.getStackTraceAsString(t)));
}
}
/** Checks for any recorded errors. This should be called at the end of process every round. */
void checkErrors() {
if (!hiltErrors.isEmpty()) {
hiltErrors.forEach(
hiltError -> {
if (hiltError.element().isPresent()) {
Element element = hiltError.element().get();
if (MoreElements.isType(element)) {
// If the error type is a TypeElement, get a new one just in case it was thrown in a
// previous round we can report the correct instance. Otherwise, this leads to
// issues in AndroidStudio when linking an error to the proper element.
// TODO(bcorso): Consider only allowing TypeElement errors when delaying errors,
// or maybe even removing delayed errors altogether.
element =
elements.getTypeElement(
MoreElements.asType(element).getQualifiedName().toString());
}
messager.printMessage(Kind.ERROR, hiltError.message(), element);
} else {
messager.printMessage(Kind.ERROR, hiltError.message());
}
});
hiltErrors.clear();
}
}
@AutoValue
abstract static class HiltError {
static HiltError of(String message) {
return of(message, Optional.empty());
}
static HiltError of(String message, Element element) {
return of(message, Optional.of(element));
}
private static HiltError of(String message, Optional<Element> element) {
return new AutoValue_ProcessorErrorHandler_HiltError(
FAILURE_PREFIX + message + FAILURE_SUFFIX, element);
}
abstract String message();
abstract Optional<Element> element();
}
}
|
