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.hilt.processor.internal.originatingelement; 18 19 import static net.ltgt.gradle.incap.IncrementalAnnotationProcessorType.ISOLATING; 20 21 import com.google.auto.common.MoreElements; 22 import com.google.auto.service.AutoService; 23 import com.google.common.collect.ImmutableSet; 24 import dagger.hilt.processor.internal.BaseProcessor; 25 import dagger.hilt.processor.internal.ClassNames; 26 import dagger.hilt.processor.internal.ProcessorErrors; 27 import dagger.hilt.processor.internal.Processors; 28 import javax.annotation.processing.Processor; 29 import javax.lang.model.element.Element; 30 import javax.lang.model.element.TypeElement; 31 import net.ltgt.gradle.incap.IncrementalAnnotationProcessor; 32 33 /** 34 * Processes the annotations annotated with {@link dagger.hilt.codegen.OriginatingElement} to check 35 * that they're only used on top-level classes and the value passed is also a top-level class. 36 */ 37 @IncrementalAnnotationProcessor(ISOLATING) 38 @AutoService(Processor.class) 39 public final class OriginatingElementProcessor extends BaseProcessor { 40 41 @Override getSupportedAnnotationTypes()42 public ImmutableSet<String> getSupportedAnnotationTypes() { 43 return ImmutableSet.of(ClassNames.ORIGINATING_ELEMENT.toString()); 44 } 45 46 @Override processEach(TypeElement annotation, Element element)47 public void processEach(TypeElement annotation, Element element) throws Exception { 48 ProcessorErrors.checkState( 49 MoreElements.isType(element) && Processors.isTopLevel(element), 50 element, 51 "@%s should only be used to annotate top-level types, but found: %s", 52 annotation.getSimpleName(), 53 element); 54 55 TypeElement originatingElementValue = 56 Processors.getAnnotationClassValue( 57 getElementUtils(), 58 Processors.getAnnotationMirror(element, ClassNames.ORIGINATING_ELEMENT), 59 "topLevelClass"); 60 61 // TODO(bcorso): ProcessorErrors should allow us to point to the annotation too. 62 ProcessorErrors.checkState( 63 Processors.isTopLevel(originatingElementValue), 64 element, 65 "@%s.topLevelClass value should be a top-level class, but found: %s", 66 annotation.getSimpleName(), 67 originatingElementValue); 68 } 69 } 70