• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2020 The Dagger Authors.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package dagger.internal.codegen.writing;
18 
19 import static com.google.common.base.Preconditions.checkArgument;
20 import static com.google.common.base.Preconditions.checkNotNull;
21 import static com.google.common.collect.Iterables.getOnlyElement;
22 import static dagger.internal.codegen.binding.AssistedInjectionAnnotations.assistedFactoryMethod;
23 import static dagger.internal.codegen.writing.AssistedInjectionParameters.assistedFactoryParameterSpecs;
24 import static dagger.internal.codegen.xprocessing.MethodSpecs.overriding;
25 import static dagger.internal.codegen.xprocessing.XElements.asTypeElement;
26 
27 import androidx.room.compiler.processing.XMethodElement;
28 import androidx.room.compiler.processing.XType;
29 import androidx.room.compiler.processing.XTypeElement;
30 import com.squareup.javapoet.ClassName;
31 import com.squareup.javapoet.CodeBlock;
32 import com.squareup.javapoet.MethodSpec;
33 import com.squareup.javapoet.TypeSpec;
34 import dagger.assisted.Assisted;
35 import dagger.assisted.AssistedFactory;
36 import dagger.assisted.AssistedInject;
37 import dagger.internal.codegen.binding.Binding;
38 import dagger.internal.codegen.binding.BindingGraph;
39 import dagger.internal.codegen.binding.ProvisionBinding;
40 import dagger.internal.codegen.javapoet.Expression;
41 import dagger.internal.codegen.model.DependencyRequest;
42 import java.util.Optional;
43 
44 /**
45  * A {@link dagger.internal.codegen.writing.RequestRepresentation} for {@link
46  * dagger.assisted.AssistedFactory} methods.
47  */
48 final class AssistedFactoryRequestRepresentation extends RequestRepresentation {
49   private final ProvisionBinding binding;
50   private final BindingGraph graph;
51   private final SimpleMethodRequestRepresentation.Factory simpleMethodRequestRepresentationFactory;
52   private final ComponentImplementation componentImplementation;
53 
54   @AssistedInject
AssistedFactoryRequestRepresentation( @ssisted ProvisionBinding binding, BindingGraph graph, ComponentImplementation componentImplementation, SimpleMethodRequestRepresentation.Factory simpleMethodRequestRepresentationFactory)55   AssistedFactoryRequestRepresentation(
56       @Assisted ProvisionBinding binding,
57       BindingGraph graph,
58       ComponentImplementation componentImplementation,
59       SimpleMethodRequestRepresentation.Factory simpleMethodRequestRepresentationFactory) {
60     this.binding = checkNotNull(binding);
61     this.graph = graph;
62     this.componentImplementation = componentImplementation;
63     this.simpleMethodRequestRepresentationFactory = simpleMethodRequestRepresentationFactory;
64   }
65 
66   @Override
getDependencyExpression(ClassName requestingClass)67   Expression getDependencyExpression(ClassName requestingClass) {
68     // An assisted factory binding should have a single request for an assisted injection type.
69     DependencyRequest assistedInjectionRequest = getOnlyElement(binding.provisionDependencies());
70     // Get corresponding assisted injection binding.
71     Optional<Binding> localBinding = graph.localContributionBinding(assistedInjectionRequest.key());
72     checkArgument(
73         localBinding.isPresent(),
74         "assisted factory should have a dependency on an assisted injection binding");
75     Expression assistedInjectionExpression =
76         simpleMethodRequestRepresentationFactory
77             .create((ProvisionBinding) localBinding.get())
78             .getDependencyExpression(requestingClass.peerClass(""));
79     return Expression.create(
80         assistedInjectionExpression.type(),
81         CodeBlock.of("$L", anonymousfactoryImpl(localBinding.get(), assistedInjectionExpression)));
82   }
83 
anonymousfactoryImpl( Binding assistedBinding, Expression assistedInjectionExpression)84   private TypeSpec anonymousfactoryImpl(
85       Binding assistedBinding, Expression assistedInjectionExpression) {
86     XTypeElement factory = asTypeElement(binding.bindingElement().get());
87     XType factoryType = binding.key().type().xprocessing();
88     XMethodElement factoryMethod = assistedFactoryMethod(factory);
89 
90     // We can't use MethodSpec.overriding directly because we need to control the parameter names.
91     MethodSpec factoryOverride = overriding(factoryMethod, factoryType).build();
92     TypeSpec.Builder builder =
93         TypeSpec.anonymousClassBuilder("")
94             .addMethod(
95                 // We're overriding the method so we have to use the jvm name here.
96                 MethodSpec.methodBuilder(factoryMethod.getJvmName())
97                     .addModifiers(factoryOverride.modifiers)
98                     .addTypeVariables(factoryOverride.typeVariables)
99                     .returns(factoryOverride.returnType)
100                     .addAnnotations(factoryOverride.annotations)
101                     .addExceptions(factoryOverride.exceptions)
102                     .addParameters(
103                         assistedFactoryParameterSpecs(
104                             binding, componentImplementation.shardImplementation(assistedBinding)))
105                     .addStatement("return $L", assistedInjectionExpression.codeBlock())
106                     .build());
107 
108     if (factory.isInterface()) {
109       builder.addSuperinterface(factoryType.getTypeName());
110     } else {
111       builder.superclass(factoryType.getTypeName());
112     }
113 
114     return builder.build();
115   }
116 
117   @AssistedFactory
118   static interface Factory {
create(ProvisionBinding binding)119     AssistedFactoryRequestRepresentation create(ProvisionBinding binding);
120   }
121 }
122