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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*
* Copyright (C) 2020 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 dagger.hilt.processor.internal.Processors.toClassNames;
import static dagger.internal.codegen.extension.DaggerStreams.toImmutableSet;
import static javax.lang.model.element.Modifier.ABSTRACT;
import static javax.lang.model.element.Modifier.PUBLIC;
import static javax.lang.model.element.Modifier.STATIC;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.graph.GraphBuilder;
import com.google.common.graph.Graphs;
import com.google.common.graph.MutableGraph;
import com.squareup.javapoet.AnnotationSpec;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;
import dagger.hilt.processor.internal.ClassNames;
import dagger.hilt.processor.internal.ComponentDescriptor;
import dagger.hilt.processor.internal.ComponentGenerator;
import dagger.hilt.processor.internal.ComponentNames;
import dagger.hilt.processor.internal.ComponentTree;
import dagger.hilt.processor.internal.Processors;
import java.io.IOException;
import java.util.Optional;
import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.Modifier;
/** Generates components and any other classes needed for a root. */
final class RootGenerator {
static void generate(RootMetadata metadata, ProcessingEnvironment env) throws IOException {
new RootGenerator(
RootMetadata.copyWithNewTree(
metadata,
filterDescriptors(metadata.componentTree())),
env).generateComponents();
}
private final RootMetadata metadata;
private final ProcessingEnvironment env;
private final Root root;
private RootGenerator(RootMetadata metadata, ProcessingEnvironment env) {
this.metadata = metadata;
this.env = env;
this.root = metadata.root();
}
private void generateComponents() throws IOException {
// TODO(bcorso): Consider moving all of this logic into ComponentGenerator?
TypeSpec.Builder componentsWrapper =
TypeSpec.classBuilder(getComponentsWrapperClassName())
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addMethod(MethodSpec.constructorBuilder().addModifiers(Modifier.PRIVATE).build());
Processors.addGeneratedAnnotation(componentsWrapper, env, ClassNames.ROOT_PROCESSOR.toString());
ImmutableMap<ComponentDescriptor, ClassName> subcomponentBuilderModules =
subcomponentBuilderModules(componentsWrapper);
ComponentTree componentTree = metadata.componentTree();
for (ComponentDescriptor componentDescriptor : componentTree.getComponentDescriptors()) {
ImmutableSet<ClassName> modules =
ImmutableSet.<ClassName>builder()
.addAll(toClassNames(metadata.modules(componentDescriptor.component())))
.addAll(
componentTree.childrenOf(componentDescriptor).stream()
.map(subcomponentBuilderModules::get)
.collect(toImmutableSet()))
.build();
componentsWrapper.addType(
new ComponentGenerator(
env,
getComponentClassName(componentDescriptor),
root.element(),
Optional.empty(),
modules,
metadata.entryPoints(componentDescriptor.component()),
metadata.scopes(componentDescriptor.component()),
ImmutableList.of(),
componentAnnotation(componentDescriptor),
componentBuilder(componentDescriptor))
.generate().toBuilder().addModifiers(Modifier.STATIC).build());
}
RootFileFormatter.write(
JavaFile.builder(root.classname().packageName(), componentsWrapper.build()).build(),
env.getFiler());
}
private static ComponentTree filterDescriptors(ComponentTree componentTree) {
MutableGraph<ComponentDescriptor> graph =
GraphBuilder.from(componentTree.graph()).build();
componentTree.graph().nodes().forEach(graph::addNode);
componentTree.graph().edges().forEach(graph::putEdge);
// Remove components that do not have builders (besides the root component) since if
// we didn't find any builder class, then we don't need to generate the component
// since it would be inaccessible.
componentTree.getComponentDescriptors().stream()
.filter(descriptor -> !descriptor.isRoot() && !descriptor.creator().isPresent())
.forEach(graph::removeNode);
// The graph may still have nodes that are children of components that don't have builders,
// so we need to find reachable nodes from the root and create a new graph to remove those.
// We reuse the root from the original tree since it should not have been removed.
return ComponentTree.from(Graphs.reachableNodes(graph, componentTree.root()));
}
private ImmutableMap<ComponentDescriptor, ClassName> subcomponentBuilderModules(
TypeSpec.Builder componentsWrapper) throws IOException {
ImmutableMap.Builder<ComponentDescriptor, ClassName> modules = ImmutableMap.builder();
for (ComponentDescriptor descriptor : metadata.componentTree().getComponentDescriptors()) {
// Root component builders don't have subcomponent builder modules
if (!descriptor.isRoot() && descriptor.creator().isPresent()) {
ClassName component = getComponentClassName(descriptor);
ClassName builder = descriptor.creator().get();
ClassName module = component.peerClass(component.simpleName() + "BuilderModule");
componentsWrapper.addType(subcomponentBuilderModule(component, builder, module));
modules.put(descriptor, module);
}
}
return modules.build();
}
// Generates:
// @Module(subcomponents = FooSubcomponent.class)
// interface FooSubcomponentBuilderModule {
// @Binds FooSubcomponentInterfaceBuilder bind(FooSubcomponent.Builder builder);
// }
private TypeSpec subcomponentBuilderModule(
ClassName componentName, ClassName builderName, ClassName moduleName) throws IOException {
TypeSpec.Builder subcomponentBuilderModule =
TypeSpec.interfaceBuilder(moduleName)
.addOriginatingElement(root.element())
.addModifiers(ABSTRACT)
.addAnnotation(
AnnotationSpec.builder(ClassNames.MODULE)
.addMember("subcomponents", "$T.class", componentName)
.build())
.addAnnotation(ClassNames.DISABLE_INSTALL_IN_CHECK)
.addMethod(
MethodSpec.methodBuilder("bind")
.addModifiers(ABSTRACT, PUBLIC)
.addAnnotation(ClassNames.BINDS)
.returns(builderName)
.addParameter(componentName.nestedClass("Builder"), "builder")
.build());
Processors.addGeneratedAnnotation(
subcomponentBuilderModule, env, ClassNames.ROOT_PROCESSOR.toString());
return subcomponentBuilderModule.build();
}
private Optional<TypeSpec> componentBuilder(ComponentDescriptor descriptor) {
return descriptor
.creator()
.map(
creator ->
TypeSpec.interfaceBuilder("Builder")
.addOriginatingElement(root.element())
.addModifiers(STATIC, ABSTRACT)
.addSuperinterface(creator)
.addAnnotation(componentBuilderAnnotation(descriptor))
.build());
}
private ClassName componentAnnotation(ComponentDescriptor componentDescriptor) {
if (!componentDescriptor.isRoot()
) {
return ClassNames.SUBCOMPONENT;
} else {
return ClassNames.COMPONENT;
}
}
private ClassName componentBuilderAnnotation(ComponentDescriptor componentDescriptor) {
if (componentDescriptor.isRoot()) {
return ClassNames.COMPONENT_BUILDER;
} else {
return ClassNames.SUBCOMPONENT_BUILDER;
}
}
private ClassName getPartialRootModuleClassName() {
return getComponentsWrapperClassName().nestedClass("PartialRootModule");
}
private ClassName getComponentsWrapperClassName() {
return ComponentNames.generatedComponentsWrapper(root.classname());
}
private ClassName getComponentClassName(ComponentDescriptor componentDescriptor) {
return ComponentNames.generatedComponent(root.classname(), componentDescriptor.component());
}
}
|
