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
220
221
222
223
224
|
/*
* Copyright (C) 2014 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.internal.codegen;
import androidx.room.compiler.processing.XProcessingEnv;
import androidx.room.compiler.processing.XProcessingEnvConfig;
import androidx.room.compiler.processing.XProcessingStep;
import androidx.room.compiler.processing.XRoundEnv;
import androidx.room.compiler.processing.XTypeElement;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.errorprone.annotations.CheckReturnValue;
import dagger.Binds;
import dagger.BindsInstance;
import dagger.Component;
import dagger.Module;
import dagger.Provides;
import dagger.internal.codegen.base.ClearableCache;
import dagger.internal.codegen.base.SourceFileGenerationException;
import dagger.internal.codegen.base.SourceFileGenerator;
import dagger.internal.codegen.binding.BindingGraphFactory;
import dagger.internal.codegen.binding.InjectBindingRegistry;
import dagger.internal.codegen.binding.MembersInjectionBinding;
import dagger.internal.codegen.binding.ModuleDescriptor;
import dagger.internal.codegen.binding.ProductionBinding;
import dagger.internal.codegen.binding.ProvisionBinding;
import dagger.internal.codegen.bindinggraphvalidation.BindingGraphValidationModule;
import dagger.internal.codegen.compileroption.CompilerOptions;
import dagger.internal.codegen.componentgenerator.ComponentGeneratorModule;
import dagger.internal.codegen.kotlin.KotlinMetadataFactory;
import dagger.internal.codegen.processingstep.ProcessingStepsModule;
import dagger.internal.codegen.validation.AnyBindingMethodValidator;
import dagger.internal.codegen.validation.BindingMethodValidatorsModule;
import dagger.internal.codegen.validation.ComponentCreatorValidator;
import dagger.internal.codegen.validation.ComponentValidator;
import dagger.internal.codegen.validation.External;
import dagger.internal.codegen.validation.ExternalBindingGraphPlugins;
import dagger.internal.codegen.validation.InjectBindingRegistryModule;
import dagger.internal.codegen.validation.InjectValidator;
import dagger.internal.codegen.validation.ValidationBindingGraphPlugins;
import dagger.internal.codegen.writing.FactoryGenerator;
import dagger.internal.codegen.writing.HjarSourceFileGenerator;
import dagger.internal.codegen.writing.MembersInjectorGenerator;
import dagger.internal.codegen.writing.ModuleGenerator;
import dagger.internal.codegen.writing.ModuleProxies.ModuleConstructorProxyGenerator;
import dagger.internal.codegen.writing.ProducerFactoryGenerator;
import dagger.multibindings.IntoSet;
import dagger.spi.model.BindingGraphPlugin;
import java.util.Optional;
import java.util.Set;
import javax.inject.Inject;
import javax.inject.Singleton;
import javax.tools.Diagnostic.Kind;
/** An implementation of Dagger's component processor that is shared between Javac and KSP. */
final class DelegateComponentProcessor {
static final XProcessingEnvConfig PROCESSING_ENV_CONFIG =
new XProcessingEnvConfig.Builder().disableAnnotatedElementValidation(true).build();
@Inject InjectBindingRegistry injectBindingRegistry;
@Inject SourceFileGenerator<ProvisionBinding> factoryGenerator;
@Inject SourceFileGenerator<MembersInjectionBinding> membersInjectorGenerator;
@Inject ImmutableList<XProcessingStep> processingSteps;
@Inject ValidationBindingGraphPlugins validationBindingGraphPlugins;
@Inject ExternalBindingGraphPlugins externalBindingGraphPlugins;
@Inject Set<ClearableCache> clearableCaches;
public void initialize(
XProcessingEnv env,
Optional<ImmutableSet<BindingGraphPlugin>> testingPlugins,
Optional<ImmutableSet<dagger.spi.BindingGraphPlugin>> legacyTestingPlugins) {
ImmutableSet<BindingGraphPlugin> plugins =
testingPlugins.orElseGet(() -> ServiceLoaders.loadServices(env, BindingGraphPlugin.class));
ImmutableSet<dagger.spi.BindingGraphPlugin> legacyPlugins =
legacyTestingPlugins.orElseGet(
() -> ServiceLoaders.loadServices(env, dagger.spi.BindingGraphPlugin.class));
if (env.getBackend() != XProcessingEnv.Backend.JAVAC) {
legacyPlugins.forEach(
legacyPlugin ->
env.getMessager()
.printMessage(
Kind.ERROR,
"Cannot use legacy dagger.spi.BindingGraphPlugin while compiling with KSP: "
+ legacyPlugin.pluginName()
+ ". Either compile with KAPT or migrate the plugin to implement "
+ "dagger.spi.model.BindingGraphPlugin."));
// Even though we've reported an error, processing will still continue for the remainder of
// the processing round to try to catch other errors. We set the javac plugins to empty to
// skip processing since it would just result in ClassCastExceptions in KSP.
legacyPlugins = ImmutableSet.of();
}
DaggerDelegateComponentProcessor_Injector.factory()
.create(env, plugins, legacyPlugins)
.inject(this);
}
public Iterable<XProcessingStep> processingSteps() {
validationBindingGraphPlugins.initializePlugins();
externalBindingGraphPlugins.initializePlugins();
return processingSteps;
}
public void postRound(XProcessingEnv env, XRoundEnv roundEnv) {
if (!roundEnv.isProcessingOver()) {
try {
injectBindingRegistry.generateSourcesForRequiredBindings(
factoryGenerator, membersInjectorGenerator);
} catch (SourceFileGenerationException e) {
e.printMessageTo(env.getMessager());
}
} else {
validationBindingGraphPlugins.endPlugins();
externalBindingGraphPlugins.endPlugins();
}
clearableCaches.forEach(ClearableCache::clearCache);
}
@Singleton
@Component(
modules = {
BindingGraphValidationModule.class,
BindingMethodValidatorsModule.class,
ComponentGeneratorModule.class,
InjectBindingRegistryModule.class,
ProcessingEnvironmentModule.class,
ProcessingRoundCacheModule.class,
ProcessingStepsModule.class,
SourceFileGeneratorsModule.class,
})
interface Injector {
void inject(DelegateComponentProcessor processor);
@Component.Factory
interface Factory {
@CheckReturnValue
Injector create(
@BindsInstance XProcessingEnv processingEnv,
@BindsInstance @External ImmutableSet<BindingGraphPlugin> externalPlugins,
@BindsInstance @External
ImmutableSet<dagger.spi.BindingGraphPlugin> legacyExternalPlugins);
}
}
@Module
interface ProcessingRoundCacheModule {
@Binds
@IntoSet
ClearableCache anyBindingMethodValidator(AnyBindingMethodValidator cache);
@Binds
@IntoSet
ClearableCache injectValidator(InjectValidator cache);
@Binds
@IntoSet
ClearableCache moduleDescriptorFactory(ModuleDescriptor.Factory cache);
@Binds
@IntoSet
ClearableCache bindingGraphFactory(BindingGraphFactory cache);
@Binds
@IntoSet
ClearableCache componentValidator(ComponentValidator cache);
@Binds
@IntoSet
ClearableCache componentCreatorValidator(ComponentCreatorValidator cache);
@Binds
@IntoSet
ClearableCache kotlinMetadata(KotlinMetadataFactory cache);
}
@Module
interface SourceFileGeneratorsModule {
@Provides
static SourceFileGenerator<ProvisionBinding> factoryGenerator(
FactoryGenerator generator, CompilerOptions compilerOptions) {
return hjarWrapper(generator, compilerOptions);
}
@Provides
static SourceFileGenerator<ProductionBinding> producerFactoryGenerator(
ProducerFactoryGenerator generator, CompilerOptions compilerOptions) {
return hjarWrapper(generator, compilerOptions);
}
@Provides
static SourceFileGenerator<MembersInjectionBinding> membersInjectorGenerator(
MembersInjectorGenerator generator, CompilerOptions compilerOptions) {
return hjarWrapper(generator, compilerOptions);
}
@Provides
@ModuleGenerator
static SourceFileGenerator<XTypeElement> moduleConstructorProxyGenerator(
ModuleConstructorProxyGenerator generator, CompilerOptions compilerOptions) {
return hjarWrapper(generator, compilerOptions);
}
}
private static <T> SourceFileGenerator<T> hjarWrapper(
SourceFileGenerator<T> generator, CompilerOptions compilerOptions) {
return compilerOptions.headerCompilation()
? HjarSourceFileGenerator.wrap(generator)
: generator;
}
}
|
