/* * Copyright (C) 2018 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.constructorBuilder; import static com.squareup.javapoet.TypeSpec.classBuilder; import static javax.lang.model.element.Modifier.FINAL; import static javax.lang.model.element.Modifier.PRIVATE; import static javax.lang.model.element.Modifier.PUBLIC; import androidx.room.compiler.processing.XElement; import androidx.room.compiler.processing.XFiler; import androidx.room.compiler.processing.XProcessingEnv; import com.google.common.collect.ImmutableList; import com.squareup.javapoet.FieldSpec; import com.squareup.javapoet.TypeSpec; import dagger.internal.codegen.base.SourceFileGenerator; import dagger.internal.codegen.binding.ContributionBinding; import dagger.internal.codegen.binding.MapKeys; import dagger.internal.codegen.javapoet.TypeNames; import dagger.internal.codegen.model.DaggerAnnotation; import javax.inject.Inject; /** * Generates a class that exposes a non-{@code public} {@link * ContributionBinding#mapKeyAnnotation()} @MapKey} annotation. */ public final class InaccessibleMapKeyProxyGenerator extends SourceFileGenerator { private final XProcessingEnv processingEnv; @Inject InaccessibleMapKeyProxyGenerator(XProcessingEnv processingEnv, XFiler filer) { super(filer, processingEnv); this.processingEnv = processingEnv; } @Override public XElement originatingElement(ContributionBinding binding) { // a map key is only ever present on bindings that have a binding element return binding.bindingElement().get(); } @Override public ImmutableList topLevelTypes(ContributionBinding binding) { return MapKeys.mapKeyFactoryMethod(binding, processingEnv) .map( method -> { TypeSpec.Builder builder = classBuilder(MapKeys.mapKeyProxyClassName(binding)) .addModifiers(PUBLIC, FINAL) .addMethod(constructorBuilder().addModifiers(PRIVATE).build()) .addMethod(method); // In proguard, we need to keep the classes referenced by @LazyClassKey, we do that by // generating a field referencing the type, and then applying @KeepFieldType to the // field. Here, we generate the field in the proxy class. For classes that are // accessible from the dagger component, we generate fields in LazyClassKeyProvider. // Note: the generated field should not be initialized to avoid class loading. binding .mapKey() .map(DaggerAnnotation::xprocessing) .filter( mapKey -> mapKey.getTypeElement().getClassName().equals(TypeNames.LAZY_CLASS_KEY)) .map( mapKey -> FieldSpec.builder(mapKey.getAsType("value").getTypeName(), "className") .addAnnotation(TypeNames.KEEP_FIELD_TYPE) .build()) .ifPresent(builder::addField); return builder; }) .map(ImmutableList::of) .orElse(ImmutableList.of()); } }