Models.kt
/*
* Copyright 2021 The Android Open Source Project
*
* 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 androidx.resourceinspection.processor
import com.squareup.javapoet.ClassName
import javax.lang.model.element.AnnotationMirror
import javax.lang.model.element.ExecutableElement
import javax.lang.model.element.TypeElement
/** Represents a view with annotated attributes, mostly a convenience class. */
internal data class View(
val type: TypeElement,
val attributes: List<Attribute>
) {
val className: ClassName = ClassName.get(type)
}
internal interface Attribute {
val name: String
val namespace: String
val type: AttributeType
val intMapping: List<IntMap>
val invocation: String
val qualifiedName: String
get() = "$namespace:$name"
}
/** Represents an `Attribute` with its getter. */
internal data class GetterAttribute(
val getter: ExecutableElement,
val annotation: AnnotationMirror,
override val namespace: String,
override val name: String,
override val type: AttributeType,
override val intMapping: List<IntMap> = emptyList()
) : Attribute {
override val invocation: String
get() = "${getter.simpleName}()"
}
/**
* Represents a shadowed platform attribute in a different namespace, mainly for AppCompat.
*
* The constructor has some reasonable defaults to make defining these as constants less toilsome.
*/
internal data class ShadowedAttribute(
override val name: String,
override val invocation: String,
override val type: AttributeType = AttributeType.OBJECT,
override val intMapping: List<IntMap> = emptyList(),
override val namespace: String = "androidx.appcompat"
) : Attribute
/** Represents an `Attribute.IntMap` entry. */
internal data class IntMap(
val name: String,
val value: Int,
val mask: Int = 0,
val annotation: AnnotationMirror? = null
)
/** Represents the type of the attribute, determined from context and the annotation itself. */
internal enum class AttributeType(val apiSuffix: String) {
BOOLEAN("Boolean"),
BYTE("Byte"),
CHAR("Char"),
DOUBLE("Double"),
FLOAT("Float"),
INT("Int"),
LONG("Long"),
SHORT("Short"),
OBJECT("Object"),
COLOR("Color"),
GRAVITY("Gravity"),
RESOURCE_ID("ResourceId"),
INT_FLAG("IntFlag"),
INT_ENUM("IntEnum")
}