commonMain.co.touchlab.skie.configuration.annotations.SealedInterop.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of configuration-annotations-jvm Show documentation

Annotations to configure SKIE behavior.

There is a newer version: 0.9.5

Show newest version

package co.touchlab.skie.configuration.annotations

@Target
annotation class SealedInterop {

    /**
     * Enables the sealed interop for the annotated declaration.
     * Has effect only if the interop is globally disabled.
     */
    @Target(AnnotationTarget.CLASS)
    @Retention(AnnotationRetention.BINARY)
    annotation class Enabled

    /**
     * Disables the sealed interop for the annotated declaration.
     */
    @Target(AnnotationTarget.CLASS)
    @Retention(AnnotationRetention.BINARY)
    annotation class Disabled

    @Target
    annotation class Function {

        /**
         * Changes the name for the generated function used inside `switch`.
         */
        @Target(AnnotationTarget.CLASS)
        @Retention(AnnotationRetention.BINARY)
        annotation class Name(val name: String)

        /**
         * Changes the argument label for the generated function used inside `switch`.
         * Disable the argument label by passing "_".
         * No argumentLabel is generated if the name is empty.
         */
        @Target(AnnotationTarget.CLASS)
        @Retention(AnnotationRetention.BINARY)
        annotation class ArgumentLabel(val argumentLabel: String)

        /**
         * Changes the parameter name for the generated function used inside `switch`.
         */
        @Target(AnnotationTarget.CLASS)
        @Retention(AnnotationRetention.BINARY)
        annotation class ParameterName(val parameterName: String)
    }

    /**
     * Changes the name for the custom `else` case that is generated if some children are hidden / not accessible from Swift.
     */
    @Target(AnnotationTarget.CLASS)
    @Retention(AnnotationRetention.BINARY)
    annotation class ElseName(val elseName: String)

    @Target
    annotation class EntireHierarchyExport {

        /**
         * If enabled, SKIE will export all sealed children of this class/interface to Obj-C even if they wouldn't be exported by Kotlin compiler.
         */
        @Target(AnnotationTarget.CLASS)
        @Retention(AnnotationRetention.BINARY)
        annotation class Enabled

        /**
         * If enabled, SKIE will not modify the default export behavior.
         */
        @Target(AnnotationTarget.CLASS)
        @Retention(AnnotationRetention.BINARY)
        annotation class Disabled
    }

    @Target
    annotation class Case {

        /**
         * Hides this subclass from the generated code, which means no dedicated enum case will be generated for it.
         */
        @Target(AnnotationTarget.CLASS)
        @Retention(AnnotationRetention.BINARY)
        annotation class Hidden

        /**
         * The dedicated enum case will be generated for this subclass even if the global configuration is set to hidden.
         */
        @Target(AnnotationTarget.CLASS)
        @Retention(AnnotationRetention.BINARY)
        annotation class Visible

        /**
         * Changes the name of the enum case generated for this subclass.
         */
        @Target(AnnotationTarget.CLASS)
        @Retention(AnnotationRetention.BINARY)
        annotation class Name(val name: String)
    }
}