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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/*
* 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.root;
import static com.google.common.base.Preconditions.checkState;
import static dagger.hilt.processor.internal.HiltCompilerOptions.isCrossCompilationRootValidationDisabled;
import static dagger.hilt.processor.internal.HiltCompilerOptions.isSharedTestComponentsEnabled;
import static dagger.hilt.processor.internal.HiltCompilerOptions.useAggregatingRootProcessor;
import static dagger.internal.codegen.extension.DaggerStreams.toImmutableList;
import static dagger.internal.codegen.extension.DaggerStreams.toImmutableSet;
import static java.util.Arrays.stream;
import androidx.room.compiler.processing.XElement;
import androidx.room.compiler.processing.XFiler.Mode;
import androidx.room.compiler.processing.XProcessingEnv;
import androidx.room.compiler.processing.XRoundEnv;
import androidx.room.compiler.processing.XTypeElement;
import com.google.common.collect.ImmutableSet;
import com.squareup.javapoet.ClassName;
import dagger.hilt.processor.internal.BadInputException;
import dagger.hilt.processor.internal.BaseProcessingStep;
import dagger.hilt.processor.internal.aggregateddeps.AggregatedDepsMetadata;
import dagger.hilt.processor.internal.aliasof.AliasOfPropagatedDataMetadata;
import dagger.hilt.processor.internal.definecomponent.DefineComponentClassesMetadata;
import dagger.hilt.processor.internal.earlyentrypoint.AggregatedEarlyEntryPointMetadata;
import dagger.hilt.processor.internal.generatesrootinput.GeneratesRootInputs;
import dagger.hilt.processor.internal.root.ir.AggregatedDepsIr;
import dagger.hilt.processor.internal.root.ir.AggregatedEarlyEntryPointIr;
import dagger.hilt.processor.internal.root.ir.AggregatedRootIr;
import dagger.hilt.processor.internal.root.ir.AggregatedRootIrValidator;
import dagger.hilt.processor.internal.root.ir.AggregatedUninstallModulesIr;
import dagger.hilt.processor.internal.root.ir.AliasOfPropagatedDataIr;
import dagger.hilt.processor.internal.root.ir.ComponentTreeDepsIr;
import dagger.hilt.processor.internal.root.ir.ComponentTreeDepsIrCreator;
import dagger.hilt.processor.internal.root.ir.DefineComponentClassesIr;
import dagger.hilt.processor.internal.root.ir.InvalidRootsException;
import dagger.hilt.processor.internal.root.ir.ProcessedRootSentinelIr;
import dagger.hilt.processor.internal.uninstallmodules.AggregatedUninstallModulesMetadata;
import dagger.internal.codegen.xprocessing.XElements;
import java.util.Set;
/** Processor that outputs dagger components based on transitive build deps. */
public final class RootProcessingStep extends BaseProcessingStep {
private boolean processed;
private GeneratesRootInputs generatesRootInputs;
public RootProcessingStep(XProcessingEnv env) {
super(env);
generatesRootInputs = new GeneratesRootInputs(processingEnv());
}
private Mode getMode() {
return useAggregatingRootProcessor(processingEnv()) ? Mode.Aggregating : Mode.Isolating;
}
@Override
protected ImmutableSet<ClassName> annotationClassNames() {
return stream(RootType.values()).map(RootType::className).collect(toImmutableSet());
}
@Override
public void processEach(ClassName annotation, XElement element) throws Exception {
XTypeElement rootElement = XElements.asTypeElement(element);
// TODO(bcorso): Move this logic into a separate isolating processor to avoid regenerating it
// for unrelated changes in Gradle.
RootType rootType = RootType.of(rootElement);
if (rootType.isTestRoot()) {
new TestInjectorGenerator(processingEnv(), TestRootMetadata.of(processingEnv(), rootElement))
.generate();
}
XTypeElement originatingRootElement =
Root.create(rootElement, processingEnv()).originatingRootElement();
new AggregatedRootGenerator(
rootElement, originatingRootElement, processingEnv().requireTypeElement(annotation))
.generate();
}
@Override
protected void postProcess(XProcessingEnv env, XRoundEnv roundEnv) throws Exception {
if (!useAggregatingRootProcessor(processingEnv())) {
return;
}
ImmutableSet<XElement> newElements =
generatesRootInputs.getElementsToWaitFor(roundEnv).stream().collect(toImmutableSet());
if (processed) {
checkState(
newElements.isEmpty(),
"Found extra modules after compilation: %s\n"
+ "(If you are adding an annotation processor that generates root input for hilt, "
+ "the annotation must be annotated with @dagger.hilt.GeneratesRootInput.\n)",
newElements.stream().map(XElements::toStableString).collect(toImmutableList()));
} else if (newElements.isEmpty()) {
processed = true;
ImmutableSet<AggregatedRootIr> rootsToProcess = rootsToProcess();
if (rootsToProcess.isEmpty()) {
return;
}
// Generate an @ComponentTreeDeps for each unique component tree.
ComponentTreeDepsGenerator componentTreeDepsGenerator =
new ComponentTreeDepsGenerator(processingEnv(), getMode());
for (ComponentTreeDepsMetadata metadata : componentTreeDepsMetadatas(rootsToProcess)) {
componentTreeDepsGenerator.generate(metadata);
}
// Generate a sentinel for all processed roots.
for (AggregatedRootIr ir : rootsToProcess) {
XTypeElement rootElement = processingEnv().requireTypeElement(ir.getRoot().canonicalName());
new ProcessedRootSentinelGenerator(rootElement, getMode()).generate();
}
}
}
private ImmutableSet<AggregatedRootIr> rootsToProcess() {
ImmutableSet<ProcessedRootSentinelIr> processedRoots =
ProcessedRootSentinelMetadata.from(processingEnv()).stream()
.map(ProcessedRootSentinelMetadata::toIr)
.collect(toImmutableSet());
ImmutableSet<AggregatedRootIr> aggregatedRoots =
AggregatedRootMetadata.from(processingEnv()).stream()
.map(AggregatedRootMetadata::toIr)
.collect(toImmutableSet());
boolean isCrossCompilationRootValidationDisabled =
isCrossCompilationRootValidationDisabled(
aggregatedRoots.stream()
.map(ir -> processingEnv().requireTypeElement(ir.getRoot().canonicalName()))
.collect(toImmutableSet()),
processingEnv());
try {
return ImmutableSet.copyOf(
AggregatedRootIrValidator.rootsToProcess(
isCrossCompilationRootValidationDisabled, processedRoots, aggregatedRoots));
} catch (InvalidRootsException ex) {
throw new BadInputException(ex.getMessage());
}
}
private ImmutableSet<ComponentTreeDepsMetadata> componentTreeDepsMetadatas(
ImmutableSet<AggregatedRootIr> aggregatedRoots) {
ImmutableSet<DefineComponentClassesIr> defineComponentDeps =
DefineComponentClassesMetadata.from(processingEnv()).stream()
.map(DefineComponentClassesMetadata::toIr)
.collect(toImmutableSet());
ImmutableSet<AliasOfPropagatedDataIr> aliasOfDeps =
AliasOfPropagatedDataMetadata.from(processingEnv()).stream()
.map(AliasOfPropagatedDataMetadata::toIr)
.collect(toImmutableSet());
ImmutableSet<AggregatedDepsIr> aggregatedDeps =
AggregatedDepsMetadata.from(processingEnv()).stream()
.map(AggregatedDepsMetadata::toIr)
.collect(toImmutableSet());
ImmutableSet<AggregatedUninstallModulesIr> aggregatedUninstallModulesDeps =
AggregatedUninstallModulesMetadata.from(processingEnv()).stream()
.map(AggregatedUninstallModulesMetadata::toIr)
.collect(toImmutableSet());
ImmutableSet<AggregatedEarlyEntryPointIr> aggregatedEarlyEntryPointDeps =
AggregatedEarlyEntryPointMetadata.from(processingEnv()).stream()
.map(AggregatedEarlyEntryPointMetadata::toIr)
.collect(toImmutableSet());
// We should be guaranteed that there are no mixed roots, so check if this is prod or test.
boolean isTest = aggregatedRoots.stream().anyMatch(AggregatedRootIr::isTestRoot);
Set<ComponentTreeDepsIr> componentTreeDeps =
ComponentTreeDepsIrCreator.components(
isTest,
isSharedTestComponentsEnabled(processingEnv()),
aggregatedRoots,
defineComponentDeps,
aliasOfDeps,
aggregatedDeps,
aggregatedUninstallModulesDeps,
aggregatedEarlyEntryPointDeps);
return componentTreeDeps.stream()
.map(it -> ComponentTreeDepsMetadata.from(it, processingEnv()))
.collect(toImmutableSet());
}
}
|
