xref: /aosp_15_r20/external/dagger2/javatests/dagger/internal/codegen/GeneratingProcessingStep.java (revision f585d8a307d0621d6060bd7e80091fdcbf94fe27)

/*
 * Copyright (C) 2022 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 static androidx.room.compiler.processing.JavaPoetExtKt.addOriginatingElement;

import androidx.room.compiler.processing.XElement;
import androidx.room.compiler.processing.XFiler;
import androidx.room.compiler.processing.XProcessingEnv;
import androidx.room.compiler.processing.XProcessingStep;
import com.google.common.collect.ImmutableSet;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.TypeName;
import com.squareup.javapoet.TypeSpec;
import java.util.Map;
import java.util.Set;

/** A simple {@link XProcessingStep} that generates one source file. */
final class GeneratingProcessingStep implements XProcessingStep {
  private final String pkgName;
  private final TypeSpec typeSpec;

  // TODO(bcorso): Ideally we'd be able to pass in a Source rather than a TypeSpec for tests, but
  // that would require XFiler supporting more generic writing of source files
  GeneratingProcessingStep(String pkgName, TypeSpec typeSpec) {
    this.pkgName = pkgName;
    this.typeSpec = typeSpec;
  }

  @Override
  public final ImmutableSet<String> annotations() {
    // TODO(b/249322175): Replace this with "*" after this bug is fixed.
    // For now, we just trigger off of annotations in the other sources in the test, but ideally
    // this should support "*" similar to javac's Processor.
    return ImmutableSet.of("dagger.Component");
  }

  @Override
  public ImmutableSet<XElement> process(
      XProcessingEnv env, Map<String, ? extends Set<? extends XElement>> elementsByAnnotation) {
    String generatedClassName = String.format("%s.%s", pkgName, typeSpec.name);
    if (env.findTypeElement(generatedClassName) == null) {
      // Add an arbitrary orginating element, otherwise XProcessing will output a warning in KSP.
      TypeSpec.Builder builder = typeSpec.toBuilder();
      addOriginatingElement(builder, env.requireTypeElement(TypeName.OBJECT));
      env.getFiler()
          .write(JavaFile.builder(pkgName, builder.build()).build(), XFiler.Mode.Isolating);
    }
    return ImmutableSet.of();
  }

  @Override
  public void processOver(
      XProcessingEnv env, Map<String, ? extends Set<? extends XElement>> elementsByAnnotation) {}
}