1 /* 2 * Copyright (C) 2024 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.android.internal.proguard; 18 19 import androidx.room.compiler.processing.XProcessingEnv; 20 import androidx.room.compiler.processing.XProcessingEnvConfig; 21 import androidx.room.compiler.processing.XProcessingStep; 22 import androidx.room.compiler.processing.ksp.KspBasicAnnotationProcessor; 23 import com.google.auto.service.AutoService; 24 import com.google.common.collect.ImmutableList; 25 import com.google.devtools.ksp.processing.SymbolProcessor; 26 import com.google.devtools.ksp.processing.SymbolProcessorEnvironment; 27 import com.google.devtools.ksp.processing.SymbolProcessorProvider; 28 29 /** 30 * An annotation processor to generate dagger-android's specific proguard needs. This is only 31 * intended to run over the dagger-android project itself, as the alternative is to create an 32 * intermediary java_library for proguard rules to be consumed by the project. 33 * 34 * <p>Basic structure looks like this: 35 * 36 * <pre><code> 37 * resources/META-INF/com.android.tools/proguard/dagger-android.pro 38 * resources/META-INF/com.android.tools/r8/dagger-android.pro 39 * resources/META-INF/proguard/dagger-android.pro 40 * </code></pre> 41 */ 42 public final class KspProguardProcessor extends KspBasicAnnotationProcessor { 43 private static final XProcessingEnvConfig PROCESSING_ENV_CONFIG = 44 new XProcessingEnvConfig.Builder().build(); 45 private XProcessingEnv env; 46 KspProguardProcessor(SymbolProcessorEnvironment symbolProcessorEnvironment)47 private KspProguardProcessor(SymbolProcessorEnvironment symbolProcessorEnvironment) { 48 super(symbolProcessorEnvironment, PROCESSING_ENV_CONFIG); 49 } 50 51 @Override initialize(XProcessingEnv env)52 public void initialize(XProcessingEnv env) { 53 this.env = env; 54 } 55 56 @Override processingSteps()57 public Iterable<XProcessingStep> processingSteps() { 58 return ImmutableList.of(new ProguardProcessingStep(env)); 59 } 60 61 /** Provides the {@link KspProguardProcessor}. */ 62 @AutoService(SymbolProcessorProvider.class) 63 public static final class Provider implements SymbolProcessorProvider { 64 @Override create(SymbolProcessorEnvironment symbolProcessorEnvironment)65 public SymbolProcessor create(SymbolProcessorEnvironment symbolProcessorEnvironment) { 66 return new KspProguardProcessor(symbolProcessorEnvironment); 67 } 68 } 69 } 70