Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
1,497 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
96 changes: 96 additions & 0 deletions
96
plugins/base/src/main/kotlin/translators/symbols/AnnotationTranslator.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| package org.jetbrains.dokka.base.translators.symbols | ||
|
|
||
| import org.jetbrains.dokka.links.Callable | ||
| import org.jetbrains.dokka.links.DRI | ||
| import org.jetbrains.dokka.model.* | ||
| import org.jetbrains.dokka.model.ClassValue | ||
| import org.jetbrains.kotlin.analysis.api.KtAnalysisSession | ||
| import org.jetbrains.kotlin.analysis.api.annotations.* | ||
| import org.jetbrains.kotlin.analysis.api.base.KtConstantValue | ||
| import org.jetbrains.kotlin.analysis.api.symbols.KtSymbol | ||
| import org.jetbrains.kotlin.analysis.api.symbols.KtSymbolOrigin | ||
| import org.jetbrains.kotlin.descriptors.annotations.AnnotationUseSiteTarget | ||
| import org.jetbrains.kotlin.name.ClassId | ||
| import org.jetbrains.kotlin.name.FqName | ||
| import org.jetbrains.kotlin.psi.KtFile | ||
|
|
||
| internal class AnnotationTranslator { | ||
| fun KtAnalysisSession.getFileLevelAnnotationsFrom(symbol: KtSymbol) = | ||
| if (symbol.origin != KtSymbolOrigin.SOURCE) | ||
| null | ||
| else | ||
| (symbol.psi?.containingFile as? KtFile)?.getFileSymbol()?.annotations?.map { toDokkaAnnotation(it) } | ||
|
|
||
| fun KtAnalysisSession.getAnnotationsFrom(annotated: KtAnnotated): List<Annotations.Annotation>? { | ||
| val directAnnotations = annotated.annotations.map { toDokkaAnnotation(it) } | ||
| val fileLevelAnnotations = (annotated as? KtSymbol)?.let { getFileLevelAnnotationsFrom(it) } ?: emptyList() | ||
| return (directAnnotations + fileLevelAnnotations) .takeUnless { it.isEmpty() } | ||
| } | ||
|
|
||
| private fun AnnotationUseSiteTarget.toDokkaAnnotationScope(): Annotations.AnnotationScope = when (this) { | ||
| AnnotationUseSiteTarget.PROPERTY_GETTER -> Annotations.AnnotationScope.GETTER | ||
| AnnotationUseSiteTarget.PROPERTY_SETTER -> Annotations.AnnotationScope.SETTER | ||
| AnnotationUseSiteTarget.FILE -> Annotations.AnnotationScope.FILE | ||
| else -> Annotations.AnnotationScope.DIRECT | ||
| } | ||
|
|
||
| private fun KtAnalysisSession.mustBeDocumented(annotationApplication: KtAnnotationApplication): Boolean { | ||
| val annotationClass = getClassOrObjectSymbolByClassId(annotationApplication.classId ?: return false) | ||
| return annotationClass?.hasAnnotation(ClassId(FqName("kotlin.annotation"), FqName("MustBeDocumented"), false)) | ||
| ?: false | ||
| } | ||
| private fun KtAnalysisSession.toDokkaAnnotation(annotationApplication: KtAnnotationApplication) = Annotations.Annotation( | ||
| dri = annotationApplication.classId?.createDRI() ?: throw IllegalStateException("The annotation application does not have class id"), | ||
| params = annotationApplication.arguments.associate { it.name.asString() to toDokkaAnnotationValue(it.expression) }, | ||
| mustBeDocumented = mustBeDocumented(annotationApplication), | ||
| scope = annotationApplication.useSiteTarget?.toDokkaAnnotationScope() ?: Annotations.AnnotationScope.DIRECT | ||
| ) | ||
|
|
||
| @OptIn(ExperimentalUnsignedTypes::class) | ||
| private fun KtAnalysisSession.toDokkaAnnotationValue(annotationValue: KtAnnotationValue): AnnotationParameterValue = when (annotationValue) { | ||
| is KtConstantAnnotationValue -> { | ||
| when(val value = annotationValue.constantValue) { | ||
| is KtConstantValue.KtNullConstantValue -> NullValue | ||
| is KtConstantValue.KtFloatConstantValue -> FloatValue(value.value) | ||
| is KtConstantValue.KtDoubleConstantValue -> DoubleValue(value.value) | ||
| is KtConstantValue.KtLongConstantValue -> LongValue(value.value) | ||
| is KtConstantValue.KtIntConstantValue -> IntValue(value.value) | ||
| is KtConstantValue.KtBooleanConstantValue -> BooleanValue(value.value) | ||
| is KtConstantValue.KtByteConstantValue -> IntValue(value.value.toInt()) | ||
| is KtConstantValue.KtCharConstantValue -> StringValue(value.value.toString()) | ||
| is KtConstantValue.KtErrorConstantValue -> StringValue(value.renderAsKotlinConstant()) | ||
| is KtConstantValue.KtShortConstantValue -> IntValue(value.value.toInt()) | ||
| is KtConstantValue.KtStringConstantValue -> StringValue(value.value) | ||
| is KtConstantValue.KtUnsignedByteConstantValue -> IntValue(value.value.toInt()) | ||
| is KtConstantValue.KtUnsignedIntConstantValue -> IntValue(value.value.toInt()) | ||
| is KtConstantValue.KtUnsignedLongConstantValue -> LongValue(value.value.toLong()) | ||
| is KtConstantValue.KtUnsignedShortConstantValue -> IntValue(value.value.toInt()) | ||
| } | ||
| } | ||
| is KtEnumEntryAnnotationValue -> EnumValue( | ||
| with(annotationValue.callableId) { this?.className?.asString() + "." + this?.callableName?.asString() }, | ||
| getDRIFrom(annotationValue) | ||
| ) | ||
| is KtArrayAnnotationValue -> ArrayValue(annotationValue.values.map { toDokkaAnnotationValue(it) }) | ||
| is KtAnnotationApplicationValue -> AnnotationValue(toDokkaAnnotation(annotationValue.annotationValue)) | ||
| is KtKClassAnnotationValue.KtNonLocalKClassAnnotationValue -> ClassValue( | ||
| annotationValue.classId.relativeClassName.asString(), | ||
| annotationValue.classId.createDRI() | ||
| ) | ||
| is KtKClassAnnotationValue.KtLocalKClassAnnotationValue -> TODO() | ||
| is KtKClassAnnotationValue.KtErrorClassAnnotationValue -> TODO() | ||
| KtUnsupportedAnnotationValue -> TODO() | ||
| } | ||
|
|
||
| private fun getDRIFrom(enumEntry: KtEnumEntryAnnotationValue): DRI { | ||
| val callableId = enumEntry.callableId ?: throw IllegalStateException("Can't get `callableId` for enum entry from annotation") | ||
| return DRI( | ||
| packageName = callableId.packageName.asString(), | ||
| classNames = callableId.className?.asString(), | ||
| callable = Callable( | ||
| callableId.callableName.asString(), | ||
| params = emptyList(), | ||
| ) | ||
| ) | ||
| } | ||
| } |
98 changes: 98 additions & 0 deletions
98
plugins/base/src/main/kotlin/translators/symbols/DRIFactory.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| package org.jetbrains.dokka.base.translators.symbols | ||
|
|
||
| import org.jetbrains.dokka.links.* | ||
| import org.jetbrains.kotlin.analysis.api.KtAnalysisSession | ||
| import org.jetbrains.kotlin.analysis.api.symbols.* | ||
| import org.jetbrains.kotlin.analysis.api.symbols.markers.KtNamedSymbol | ||
| import org.jetbrains.kotlin.analysis.api.symbols.markers.KtSymbolWithTypeParameters | ||
| import org.jetbrains.kotlin.analysis.api.types.KtNonErrorClassType | ||
| import org.jetbrains.kotlin.name.CallableId | ||
| import org.jetbrains.kotlin.name.ClassId | ||
|
|
||
| internal fun ClassId.createDRI(): DRI = DRI( | ||
| packageName = this.packageFqName.asString(), classNames = this.relativeClassName.asString() | ||
| ) | ||
|
|
||
| private fun CallableId.createDRI(receiver: TypeReference?, params: List<TypeReference>): DRI = DRI( | ||
| packageName = this.packageName.asString(), | ||
| classNames = this.className?.asString(), | ||
| callable = Callable( | ||
| this.callableName.asString(), | ||
| params = params, | ||
| receiver = receiver | ||
| ) | ||
| ) | ||
|
|
||
| internal fun getDRIFromNonErrorClassType(nonErrorClassType: KtNonErrorClassType): DRI = nonErrorClassType.classId.createDRI() | ||
|
|
||
| internal fun getDRIFromEnumEntry(symbol: KtEnumEntrySymbol): DRI = | ||
| symbol.callableIdIfNonLocal?.createDRI(null, emptyList())?.withEnumEntryExtra() | ||
| ?: throw IllegalStateException("") | ||
|
|
||
| internal fun KtAnalysisSession.getDRIFromTypeParameter(symbol: KtTypeParameterSymbol): DRI { | ||
| val containingSymbol = | ||
| symbol.getContainingSymbol() ?: throw IllegalStateException("`getContainingSymbol` is null for type parameter") | ||
| val typeParameters = (containingSymbol as? KtSymbolWithTypeParameters)?.typeParameters | ||
| val index = typeParameters?.indexOfFirst { symbol.name == it.name } ?: -1 | ||
| return if (index == -1) | ||
| getDRIFromSymbol(containingSymbol) | ||
| else | ||
| getDRIFromSymbol(containingSymbol).copy(target = PointingToGenericParameters(index)) | ||
| } | ||
|
|
||
| internal fun KtAnalysisSession.getDRIFromConstructor(symbol: KtConstructorSymbol): DRI = | ||
| symbol.containingClassIdIfNonLocal?.createDRI()?.copy( | ||
| callable = Callable( | ||
| name = symbol.containingClassIdIfNonLocal?.relativeClassName?.asString() ?: "", | ||
| params = symbol.valueParameters.map { getTypeReferenceFrom(it.returnType) } | ||
| )) | ||
| ?: throw IllegalStateException("") | ||
|
|
||
| internal fun KtAnalysisSession.getDRIFromVariableLike(symbol: KtVariableLikeSymbol): DRI { | ||
| val receiver = symbol.receiverType?.let {// TODO: replace `receiverType` with `receiverParameter` | ||
| getTypeReferenceFrom(it) | ||
| } | ||
| return symbol.callableIdIfNonLocal?.createDRI(receiver, emptyList()) | ||
| ?: throw IllegalStateException("") | ||
| } | ||
|
|
||
| internal fun KtAnalysisSession.getDRIFromFunctionLike(symbol: KtFunctionLikeSymbol): DRI { | ||
| val params = symbol.valueParameters.map { getTypeReferenceFrom(it.returnType) } | ||
| val receiver = symbol.receiverType?.let { // TODO: replace `receiverType` with `receiverParameter` | ||
| getTypeReferenceFrom(it) | ||
| } | ||
| return symbol.callableIdIfNonLocal?.createDRI(receiver, params) | ||
| ?: getDRIFromLocalFunction(symbol) | ||
| } | ||
|
|
||
| internal fun getDRIFromClassLike(symbol: KtClassLikeSymbol): DRI = | ||
| symbol.classIdIfNonLocal?.createDRI() ?: throw IllegalStateException() | ||
|
|
||
| internal fun KtAnalysisSession.getDRIFromSymbol(symbol: KtSymbol): DRI = | ||
| when (symbol) { | ||
| is KtEnumEntrySymbol -> getDRIFromEnumEntry(symbol) | ||
| is KtTypeParameterSymbol -> getDRIFromTypeParameter(symbol) | ||
| is KtConstructorSymbol -> getDRIFromConstructor(symbol) | ||
| is KtVariableLikeSymbol -> getDRIFromVariableLike(symbol) | ||
| is KtFunctionLikeSymbol -> getDRIFromFunctionLike(symbol) | ||
| is KtClassLikeSymbol -> getDRIFromClassLike(symbol) | ||
| else -> throw IllegalStateException("Unknown symbol while creating DRI ") | ||
| } | ||
|
|
||
| private fun KtAnalysisSession.getDRIFromLocalFunction(symbol: KtFunctionLikeSymbol): DRI { | ||
| /** | ||
| * in enum entry: memberSymbol.callableIdIfNonLocal=null | ||
| */ | ||
| return getDRIFromSymbol(symbol.getContainingSymbol() as KtSymbol).copy( | ||
| callable = Callable( | ||
| (symbol as? KtNamedSymbol)?.name?.asString() ?: "", | ||
| params = symbol.valueParameters.map { getTypeReferenceFrom(it.returnType) }, | ||
| receiver = symbol.receiverType?.let { // TODO: replace `receiverType` with `receiverParameter` | ||
| getTypeReferenceFrom(it) | ||
| } | ||
| // receiver = symbol.receiverParameter?.let { | ||
| // getTypeReferenceFrom(it) | ||
| // } | ||
| ) | ||
| ) | ||
| } |
Oops, something went wrong.