com.connectrpc.protocgen.connect.internal.CodeGenerator.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of protoc-gen-connect-kotlin Show documentation

Simple, reliable, interoperable. A better RPC.

There is a newer version: 0.7.2

Show newest version

// Copyright 2022-2023 The Connect Authors
//
// 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 com.connectrpc.protocgen.connect.internal

import com.connectrpc.protocgen.connect.internal.Plugin.DescriptorSource
import com.google.protobuf.DescriptorProtos.Edition
import com.google.protobuf.compiler.PluginProtos

/**
 * Interface to be implemented by a code generator.
 */
interface CodeGenerator {
    /**
     * Generates code for the given proto file, generating one or more files to
     * the given response.
     */
    fun generate(
        request: PluginProtos.CodeGeneratorRequest,
        descriptorSource: DescriptorSource,
        response: Plugin.Response,
    )

    /**
     * Returns an array of supported Protobuf features.
     */
    fun getSupportedFeatures(): Array

    /**
     * Returns the minimum edition (inclusive) supported by this generator. Any
     * proto files with an edition before this will result in an error.
     */
    fun getMinimumEdition(): Edition

    /**
     * Returns the maximum edition (inclusive) supported by this generator. Any
     * proto files with an edition after this will result in an error.
     */
    fun getMaximumEdition(): Edition
}