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
|
/*
* 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 static dagger.internal.codegen.extension.DaggerStreams.toImmutableList;
import static java.util.Comparator.comparing;
import com.google.common.base.Joiner;
import com.google.common.base.Utf8;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.squareup.javapoet.AnnotationSpec;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.TypeName;
import com.squareup.javapoet.TypeSpec;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
/** Generates a Dagger component or subcomponent interface. */
// TODO(bcorso): Make this non-public
public final class ComponentGenerator {
private static final Joiner JOINER = Joiner.on(".");
private static final Comparator<ClassName> SIMPLE_NAME_SORTER =
Comparator.comparing((ClassName c) -> JOINER.join(c.simpleNames()))
.thenComparing(ClassName::compareTo);
private static final Comparator<TypeName> TYPE_NAME_SORTER = comparing(TypeName::toString);
private final ProcessingEnvironment processingEnv;
private final ClassName name;
private final TypeElement rootElement;
private final Optional<ClassName> superclass;
private final ImmutableList<ClassName> modules;
private final ImmutableList<TypeName> entryPoints;
private final ImmutableCollection<ClassName> scopes;
private final ImmutableList<AnnotationSpec> extraAnnotations;
private final ClassName componentAnnotation;
private final Optional<TypeSpec> componentBuilder;
public ComponentGenerator(
ProcessingEnvironment processingEnv,
ClassName name,
TypeElement rootElement,
Optional<ClassName> superclass,
Set<? extends ClassName> modules,
Set<? extends TypeName> entryPoints,
ImmutableCollection<ClassName> scopes,
ImmutableList<AnnotationSpec> extraAnnotations,
ClassName componentAnnotation,
Optional<TypeSpec> componentBuilder) {
this.processingEnv = processingEnv;
this.name = name;
this.rootElement = rootElement;
this.superclass = superclass;
this.modules = modules.stream().sorted(SIMPLE_NAME_SORTER).collect(toImmutableList());
this.entryPoints = entryPoints.stream().sorted(TYPE_NAME_SORTER).collect(toImmutableList());
this.scopes = scopes;
this.extraAnnotations = extraAnnotations;
this.componentAnnotation = componentAnnotation;
this.componentBuilder = componentBuilder;
}
public TypeSpec generate() throws IOException {
TypeSpec.Builder generator =
TypeSpec.classBuilder(name)
// Public because components from a scope below must reference to create
.addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
.addOriginatingElement(rootElement)
.addAnnotation(getComponentAnnotation());
componentBuilder.ifPresent(generator::addType);
scopes.forEach(generator::addAnnotation);
addEntryPoints(generator);
superclass.ifPresent(generator::superclass);
generator.addAnnotations(extraAnnotations);
return generator.build();
}
/** Returns the component annotation with the list of modules to install for the component. */
private AnnotationSpec getComponentAnnotation() {
AnnotationSpec.Builder builder = AnnotationSpec.builder(componentAnnotation);
modules.forEach(module -> builder.addMember("modules", "$T.class", module));
return builder.build();
}
/**
* Adds entry points to the component.
*
* See b/140979968. If the entry points exceed 65763 bytes, we have to partition them to avoid the
* limit. To be safe, we split at 60000 bytes.
*/
private void addEntryPoints(TypeSpec.Builder builder) throws IOException {
int currBytes = 0;
List<Integer> partitionIndexes = new ArrayList<>();
partitionIndexes.add(0);
for (int i = 0; i < entryPoints.size(); i++) {
// This over estimates the actual length because it includes the fully qualified name (FQN).
// TODO(bcorso): Have a better way to estimate the upper bound. For example, most types will
// not include the FQN, but we'll have to consider all of the different subtypes of TypeName,
// simple name collisions, etc...
int nextBytes = Utf8.encodedLength(entryPoints.get(i).toString());
// To be safe, we split at 60000 to account for the component name, spaces, commas, etc...
if (currBytes + nextBytes > 60000) {
partitionIndexes.add(i);
currBytes = 0;
}
currBytes += nextBytes;
}
partitionIndexes.add(entryPoints.size());
if (partitionIndexes.size() <= 2) {
// No extra partitions are needed, so just add all of the entrypoints as is.
builder.addSuperinterfaces(entryPoints);
} else {
// Create interfaces for each partition.
// The partitioned interfaces will be added to the component instead of the real entry points.
for (int i = 1; i < partitionIndexes.size(); i++) {
int startIndex = partitionIndexes.get(i - 1);
int endIndex = partitionIndexes.get(i);
builder.addSuperinterface(
createPartitionInterface(entryPoints.subList(startIndex, endIndex), i));
}
}
}
private ClassName createPartitionInterface(List<TypeName> partition, int partitionIndex)
throws IOException {
// TODO(bcorso): Nest the partion inside the HiltComponents wrapper rather than appending name
ClassName partitionName =
Processors.append(
Processors.getEnclosedClassName(name), "_EntryPointPartition" + partitionIndex);
TypeSpec.Builder builder =
TypeSpec.interfaceBuilder(partitionName)
.addOriginatingElement(rootElement)
.addModifiers(Modifier.ABSTRACT)
.addSuperinterfaces(partition);
Processors.addGeneratedAnnotation(builder, processingEnv, ClassNames.ROOT_PROCESSOR.toString());
JavaFile.builder(name.packageName(), builder.build()).build().writeTo(processingEnv.getFiler());
return partitionName;
}
}
|
