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
|
/*
* 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.android.processor.internal.viewmodel
import androidx.room.compiler.codegen.XTypeName
import androidx.room.compiler.processing.ExperimentalProcessingApi
import androidx.room.compiler.processing.XProcessingEnv
import androidx.room.compiler.processing.addOriginatingElement
import com.squareup.javapoet.AnnotationSpec
import com.squareup.javapoet.ClassName
import com.squareup.javapoet.JavaFile
import com.squareup.javapoet.MethodSpec
import com.squareup.javapoet.TypeName
import com.squareup.javapoet.TypeSpec
import dagger.hilt.android.processor.internal.AndroidClassNames
import dagger.hilt.processor.internal.ClassNames
import dagger.hilt.processor.internal.Processors
import javax.lang.model.element.Modifier
/**
* Source generator to support Hilt injection of ViewModels.
*
* Should generate:
* ```
* public final class $_HiltModules {
* @Module
* @InstallIn(ViewModelComponent.class)
* public static abstract class BindsModule {
* @Binds
* @IntoMap
* @StringKey("pkg.$")
* @HiltViewModelMap
* public abstract ViewModel bind($ vm)
* }
* @Module
* @InstallIn(ActivityRetainedComponent.class)
* public static final class KeyModule {
* @Provides
* @IntoSet
* @HiltViewModelMap.KeySet
* public static String provide() {
* return "pkg.$";
* }
* }
* }
* ```
*/
@OptIn(ExperimentalProcessingApi::class)
internal class ViewModelModuleGenerator(
private val processingEnv: XProcessingEnv,
private val viewModelMetadata: ViewModelMetadata
) {
fun generate() {
val modulesTypeSpec =
TypeSpec.classBuilder(viewModelMetadata.modulesClassName)
.apply {
addOriginatingElement(viewModelMetadata.viewModelElement)
Processors.addGeneratedAnnotation(this, processingEnv, ViewModelProcessor::class.java)
addAnnotation(
AnnotationSpec.builder(ClassNames.ORIGINATING_ELEMENT)
.addMember(
"topLevelClass",
"$T.class",
viewModelMetadata.className.topLevelClassName()
)
.build()
)
addModifiers(Modifier.PUBLIC, Modifier.FINAL)
addType(getBindsModuleTypeSpec())
addType(getKeyModuleTypeSpec())
addMethod(MethodSpec.constructorBuilder().addModifiers(Modifier.PRIVATE).build())
}
.build()
processingEnv.filer.write(
JavaFile.builder(viewModelMetadata.modulesClassName.packageName(), modulesTypeSpec).build()
)
}
private fun getBindsModuleTypeSpec() =
createModuleTypeSpec(
className = "BindsModule",
component = AndroidClassNames.VIEW_MODEL_COMPONENT
)
.addModifiers(Modifier.ABSTRACT)
.addMethod(MethodSpec.constructorBuilder().addModifiers(Modifier.PRIVATE).build())
.addMethod(
if (viewModelMetadata.assistedFactory.asClassName() != XTypeName.ANY_OBJECT) {
getAssistedViewModelBindsMethod()
} else {
getViewModelBindsMethod()
}
)
.build()
private fun getViewModelBindsMethod() =
MethodSpec.methodBuilder("binds")
.addAnnotation(ClassNames.BINDS)
.addAnnotation(ClassNames.INTO_MAP)
.addAnnotation(
AnnotationSpec.builder(ClassNames.STRING_KEY)
.addMember("value", S, viewModelMetadata.className.reflectionName())
.build()
)
.addAnnotation(AndroidClassNames.HILT_VIEW_MODEL_MAP_QUALIFIER)
.addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
.returns(AndroidClassNames.VIEW_MODEL)
.addParameter(viewModelMetadata.className, "vm")
.build()
private fun getKeyModuleTypeSpec() =
createModuleTypeSpec(
className = "KeyModule",
component = AndroidClassNames.ACTIVITY_RETAINED_COMPONENT
)
.addModifiers(Modifier.FINAL)
.addMethod(MethodSpec.constructorBuilder().addModifiers(Modifier.PRIVATE).build())
.addMethod(getViewModelKeyProvidesMethod())
.build()
private fun getViewModelKeyProvidesMethod() =
MethodSpec.methodBuilder("provide")
.addAnnotation(ClassNames.PROVIDES)
.addAnnotation(ClassNames.INTO_SET)
.addAnnotation(AndroidClassNames.HILT_VIEW_MODEL_KEYS_QUALIFIER)
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.returns(String::class.java)
.addStatement("return $S", viewModelMetadata.className.reflectionName())
.build()
/**
* Should generate:
* ```
* @Binds
* @IntoMap
* @StringKey("pkg.FooViewModel")
* @HiltViewModelAssistedMap
* public abstract Object bind(FooViewModelAssistedFactory factory);
* ```
*
* So that we have a HiltViewModelAssistedMap that maps from fully qualified ViewModel names to
* its assisted factory instance.
*/
private fun getAssistedViewModelBindsMethod() =
MethodSpec.methodBuilder("bind")
.addAnnotation(ClassNames.BINDS)
.addAnnotation(ClassNames.INTO_MAP)
.addAnnotation(
AnnotationSpec.builder(ClassNames.STRING_KEY)
.addMember("value", S, viewModelMetadata.className.reflectionName())
.build()
)
.addAnnotation(AndroidClassNames.HILT_VIEW_MODEL_ASSISTED_FACTORY_MAP_QUALIFIER)
.addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
.addParameter(viewModelMetadata.assistedFactoryClassName, "factory")
.returns(TypeName.OBJECT)
.build()
private fun createModuleTypeSpec(className: String, component: ClassName) =
TypeSpec.classBuilder(className)
.addOriginatingElement(viewModelMetadata.viewModelElement)
.addAnnotation(ClassNames.MODULE)
.addAnnotation(
AnnotationSpec.builder(ClassNames.INSTALL_IN)
.addMember("value", "$T.class", component)
.build()
)
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
companion object {
const val L = "\$L"
const val T = "\$T"
const val N = "\$N"
const val S = "\$S"
const val W = "\$W"
}
}
|
