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
|
/*
* 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.android.processor.internal.androidentrypoint;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.FieldSpec;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;
import com.squareup.javapoet.TypeVariableName;
import dagger.hilt.android.processor.internal.AndroidClassNames;
import dagger.hilt.processor.internal.ClassNames;
import dagger.hilt.processor.internal.Processors;
import java.io.IOException;
import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.Modifier;
/** Generates an Hilt Fragment class for the @AndroidEntryPoint annotated class. */
public final class FragmentGenerator {
private static final FieldSpec COMPONENT_CONTEXT_FIELD =
FieldSpec.builder(AndroidClassNames.CONTEXT_WRAPPER, "componentContext")
.addModifiers(Modifier.PRIVATE)
.build();
private final ProcessingEnvironment env;
private final AndroidEntryPointMetadata metadata;
private final ClassName generatedClassName;
public FragmentGenerator(
ProcessingEnvironment env,
AndroidEntryPointMetadata metadata ) {
this.env = env;
this.metadata = metadata;
generatedClassName = metadata.generatedClassName();
}
public void generate() throws IOException {
JavaFile.builder(generatedClassName.packageName(), createTypeSpec())
.build()
.writeTo(env.getFiler());
}
// @Generated("FragmentGenerator")
// abstract class Hilt_$CLASS extends $BASE implements ComponentManager<?> {
// ...
// }
TypeSpec createTypeSpec() {
TypeSpec.Builder builder =
TypeSpec.classBuilder(generatedClassName.simpleName())
.addOriginatingElement(metadata.element())
.superclass(metadata.baseClassName())
.addModifiers(metadata.generatedClassModifiers())
.addField(COMPONENT_CONTEXT_FIELD)
.addMethod(onAttachContextMethod())
.addMethod(onAttachActivityMethod())
.addMethod(initializeComponentContextMethod())
.addMethod(getContextMethod())
.addMethod(inflatorMethod());
Generators.addGeneratedBaseClassJavadoc(builder, AndroidClassNames.ANDROID_ENTRY_POINT);
Processors.addGeneratedAnnotation(builder, env, getClass());
Generators.copyLintAnnotations(metadata.element(), builder);
Generators.addSuppressAnnotation(builder, "deprecation");
Generators.copyConstructors(metadata.baseElement(), builder);
metadata.baseElement().getTypeParameters().stream()
.map(TypeVariableName::get)
.forEachOrdered(builder::addTypeVariable);
Generators.addComponentOverride(metadata, builder);
Generators.addInjectionMethods(metadata, builder);
if (!metadata.overridesAndroidEntryPointClass() ) {
builder.addMethod(getDefaultViewModelProviderFactory());
}
return builder.build();
}
// @CallSuper
// @Override
// public void onAttach(Activity activity) {
// super.onAttach(activity);
// initializeComponentContext();
// }
private static MethodSpec onAttachContextMethod() {
return MethodSpec.methodBuilder("onAttach")
.addAnnotation(Override.class)
.addAnnotation(AndroidClassNames.CALL_SUPER)
.addModifiers(Modifier.PUBLIC)
.addParameter(AndroidClassNames.CONTEXT, "context")
.addStatement("super.onAttach(context)")
.addStatement("initializeComponentContext()")
.build();
}
// @CallSuper
// @Override
// public void onAttach(Activity activity) {
// super.onAttach(activity);
// Preconditions.checkState(
// componentContext == null || FragmentComponentManager.findActivity(
// componentContext) == activity, "...");
// initializeComponentContext();
// }
private static MethodSpec onAttachActivityMethod() {
return MethodSpec.methodBuilder("onAttach")
.addAnnotation(Override.class)
.addAnnotation(AndroidClassNames.CALL_SUPER)
.addAnnotation(AndroidClassNames.MAIN_THREAD)
.addModifiers(Modifier.PUBLIC)
.addParameter(AndroidClassNames.ACTIVITY, "activity")
.addStatement("super.onAttach(activity)")
.addStatement(
"$T.checkState($N == null || $T.findActivity($N) == activity, $S)",
ClassNames.PRECONDITIONS,
COMPONENT_CONTEXT_FIELD,
AndroidClassNames.FRAGMENT_COMPONENT_MANAGER,
COMPONENT_CONTEXT_FIELD,
"onAttach called multiple times with different Context! "
+ "Hilt Fragments should not be retained.")
.addStatement("initializeComponentContext()")
.build();
}
// private void initializeComponentContext() {
// // Only inject on the first call to onAttach.
// if (componentContext == null) {
// // Note: The LayoutInflater provided by this componentContext may be different from super
// // Fragment's because we are getting it from base context instead of cloning from super
// // Fragment's LayoutInflater.
// componentContext = FragmentComponentManager.createContextWrapper(super.getContext(), this);
// inject();
// }
// }
private MethodSpec initializeComponentContextMethod() {
return MethodSpec.methodBuilder("initializeComponentContext")
.addModifiers(Modifier.PRIVATE)
.addComment("Only inject on the first call to onAttach.")
.beginControlFlow("if ($N == null)", COMPONENT_CONTEXT_FIELD)
.addComment(
"Note: The LayoutInflater provided by this componentContext may be different from"
+ " super Fragment's because we getting it from base context instead of cloning"
+ " from the super Fragment's LayoutInflater.")
.addStatement(
"$N = $T.createContextWrapper(super.getContext(), this)",
COMPONENT_CONTEXT_FIELD,
metadata.componentManager())
.addStatement("inject()")
.endControlFlow()
.build();
}
// @Override
// public Context getContext() {
// return componentContext;
// }
private static MethodSpec getContextMethod() {
return MethodSpec.methodBuilder("getContext")
.returns(AndroidClassNames.CONTEXT)
.addAnnotation(Override.class)
.addModifiers(Modifier.PUBLIC)
.addStatement("return $N", COMPONENT_CONTEXT_FIELD)
.build();
}
// @Override
// public LayoutInflater onGetLayoutInflater(Bundle savedInstanceState) {
// LayoutInflater inflater = super.onGetLayoutInflater(savedInstanceState);
// return LayoutInflater.from(FragmentComponentManager.createContextWrapper(inflater, this));
// }
private MethodSpec inflatorMethod() {
return MethodSpec.methodBuilder("onGetLayoutInflater")
.addAnnotation(Override.class)
.addModifiers(Modifier.PUBLIC)
.addParameter(AndroidClassNames.BUNDLE, "savedInstanceState")
.returns(AndroidClassNames.LAYOUT_INFLATER)
.addStatement(
"$T inflater = super.onGetLayoutInflater(savedInstanceState)",
AndroidClassNames.LAYOUT_INFLATER)
.addStatement(
"return $T.from($T.createContextWrapper(inflater, this))",
AndroidClassNames.LAYOUT_INFLATER,
metadata.componentManager())
.build();
}
// @Override
// public ViewModelProvider.Factory getDefaultViewModelProviderFactory() {
// return DefaultViewModelFactories.getFragmentFactory(
// this, super.getDefaultViewModelProviderFactory());
// }
private MethodSpec getDefaultViewModelProviderFactory() {
return MethodSpec.methodBuilder("getDefaultViewModelProviderFactory")
.addAnnotation(Override.class)
.addModifiers(Modifier.PUBLIC)
.returns(AndroidClassNames.VIEW_MODEL_PROVIDER_FACTORY)
.addStatement(
"return $T.getFragmentFactory(this, super.getDefaultViewModelProviderFactory())",
AndroidClassNames.DEFAULT_VIEW_MODEL_FACTORIES)
.build();
}
}
|
