org.jetbrains.dokka.base.templating.jsonMapperForPlugins.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dokka-base Show documentation

Dokka is an API documentation engine for Kotlin

There is a newer version: 2.0.0

/*
 * Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 */

package org.jetbrains.dokka.base.templating

import com.fasterxml.jackson.core.JsonGenerator
import com.fasterxml.jackson.databind.DeserializationFeature
import com.fasterxml.jackson.databind.SerializerProvider
import com.fasterxml.jackson.databind.module.SimpleModule
import com.fasterxml.jackson.databind.ser.std.StdScalarSerializer
import com.fasterxml.jackson.databind.type.TypeFactory
import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
import com.fasterxml.jackson.module.kotlin.jacksonTypeRef
import org.jetbrains.dokka.base.DokkaBase
import java.io.File

// TODO [beresnev] try to get rid of this copy-paste in #2933
// THIS IS COPIED FROM BASE SINCE IT NEEDS TO BE INSTANTIATED ON THE SAME CLASS LOADER AS PLUGINS

private val objectMapper = run {
    val module = SimpleModule().apply {
        addSerializer(FileSerializer)
    }
    jacksonObjectMapper()
        .apply {
            typeFactory = PluginTypeFactory()
        }
        .registerModule(module)
        .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
}

@PublishedApi
internal class TypeReference @PublishedApi internal constructor(
    internal val jackson: com.fasterxml.jackson.core.type.TypeReference
) {
    companion object {
        @PublishedApi
        internal inline operator fun  invoke(): TypeReference = TypeReference(jacksonTypeRef())
    }
}

public fun toJsonString(value: Any): String = objectMapper.writeValueAsString(value)

public inline fun  parseJson(json: String): T = parseJson(json, TypeReference())

@PublishedApi
internal fun  parseJson(json: String, typeReference: TypeReference): T =
    objectMapper.readValue(json, typeReference.jackson)


private object FileSerializer : StdScalarSerializer(File::class.java) {
    override fun serialize(value: File, g: JsonGenerator, provider: SerializerProvider) {
        g.writeString(value.path)
    }
}

@Suppress("DEPRECATION") // for TypeFactory constructor, no way to use non-deprecated one, it's essentially identical
private class PluginTypeFactory: TypeFactory(null) {
    override fun findClass(className: String): Class? =
        Class.forName(className, true, DokkaBase::class.java.classLoader) ?: super.findClass(className)
}