/* * Copyright (C) 2017 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.writing; import static com.squareup.javapoet.MethodSpec.methodBuilder; import static dagger.internal.codegen.base.Util.reentrantComputeIfAbsent; import static dagger.internal.codegen.langmodel.Accessibility.isTypeAccessibleFrom; import static dagger.internal.codegen.writing.ComponentImplementation.MethodSpecKind.MEMBERS_INJECTION_METHOD; import static dagger.internal.codegen.xprocessing.XElements.getSimpleName; import static javax.lang.model.element.Modifier.PRIVATE; import androidx.room.compiler.processing.XProcessingEnv; import androidx.room.compiler.processing.XType; import androidx.room.compiler.processing.XTypeElement; import com.google.common.collect.ImmutableSet; import com.squareup.javapoet.ClassName; import com.squareup.javapoet.CodeBlock; import com.squareup.javapoet.MethodSpec; import com.squareup.javapoet.ParameterSpec; import com.squareup.javapoet.TypeName; import dagger.internal.codegen.binding.Binding; import dagger.internal.codegen.binding.BindingGraph; import dagger.internal.codegen.binding.MembersInjectionBinding; import dagger.internal.codegen.binding.MembersInjectionBinding.InjectionSite; import dagger.internal.codegen.binding.ProvisionBinding; import dagger.internal.codegen.javapoet.Expression; import dagger.internal.codegen.model.Key; import dagger.internal.codegen.writing.ComponentImplementation.ShardImplementation; import dagger.internal.codegen.writing.InjectionMethods.InjectionSiteMethod; import java.util.LinkedHashMap; import java.util.Map; import javax.inject.Inject; /** Manages the member injection methods for a component. */ @PerComponentImplementation final class MembersInjectionMethods { private final Map injectMethodExpressions = new LinkedHashMap<>(); private final ComponentImplementation componentImplementation; private final ComponentRequestRepresentations bindingExpressions; private final BindingGraph graph; private final XProcessingEnv processingEnv; @Inject MembersInjectionMethods( ComponentImplementation componentImplementation, ComponentRequestRepresentations bindingExpressions, BindingGraph graph, XProcessingEnv processingEnv) { this.componentImplementation = componentImplementation; this.bindingExpressions = bindingExpressions; this.graph = graph; this.processingEnv = processingEnv; } /** * Returns the members injection {@link Expression} for the given {@link Key}, creating it if * necessary. */ Expression getInjectExpression(Key key, CodeBlock instance, ClassName requestingClass) { Binding binding = graph.localMembersInjectionBinding(key).isPresent() ? graph.localMembersInjectionBinding(key).get() : graph.localContributionBinding(key).get(); Expression expression = reentrantComputeIfAbsent( injectMethodExpressions, key, k -> injectMethodExpression(binding)); ShardImplementation shardImplementation = componentImplementation.shardImplementation(binding); return Expression.create( expression.type(), shardImplementation.name().equals(requestingClass) ? CodeBlock.of("$L($L)", expression.codeBlock(), instance) : CodeBlock.of( "$L.$L($L)", shardImplementation.shardFieldReference(), expression.codeBlock(), instance)); } private Expression injectMethodExpression(Binding binding) { // TODO(wanyingd): move Switching Providers and injection methods to Shard classes to avoid // exceeding component class constant pool limit. // Add to Component Shard so that is can be accessible from Switching Providers. ShardImplementation shardImplementation = componentImplementation.shardImplementation(binding); XType keyType = binding.key().type().xprocessing(); XType membersInjectedType = isTypeAccessibleFrom(keyType, shardImplementation.name().packageName()) ? keyType : processingEnv.requireType(TypeName.OBJECT); String bindingTypeName = getSimpleName(binding.bindingTypeElement().get()); // TODO(ronshapiro): include type parameters in this name e.g. injectFooOfT, and outer class // simple names Foo.Builder -> injectFooBuilder String methodName = shardImplementation.getUniqueMethodName("inject" + bindingTypeName); ParameterSpec parameter = ParameterSpec.builder(membersInjectedType.getTypeName(), "instance").build(); MethodSpec.Builder methodBuilder = methodBuilder(methodName) .addModifiers(PRIVATE) .returns(membersInjectedType.getTypeName()) .addParameter(parameter); XTypeElement canIgnoreReturnValue = processingEnv.findTypeElement("com.google.errorprone.annotations.CanIgnoreReturnValue"); if (canIgnoreReturnValue != null) { methodBuilder.addAnnotation(canIgnoreReturnValue.getClassName()); } CodeBlock instance = CodeBlock.of("$N", parameter); methodBuilder.addCode( InjectionSiteMethod.invokeAll( injectionSites(binding), shardImplementation.name(), instance, membersInjectedType, request -> bindingExpressions .getDependencyArgumentExpression(request, shardImplementation.name()) .codeBlock())); methodBuilder.addStatement("return $L", instance); MethodSpec method = methodBuilder.build(); shardImplementation.addMethod(MEMBERS_INJECTION_METHOD, method); return Expression.create(membersInjectedType, CodeBlock.of("$N", method)); } private static ImmutableSet injectionSites(Binding binding) { if (binding instanceof ProvisionBinding) { return ((ProvisionBinding) binding).injectionSites(); } else if (binding instanceof MembersInjectionBinding) { return ((MembersInjectionBinding) binding).injectionSites(); } throw new IllegalArgumentException(binding.key().toString()); } }