commonMain.com.squareup.kotlinpoet.ContextReceivable.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2022 Square, Inc.
 *
 * 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
 *
 * https://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.squareup.kotlinpoet

/** A KotlinPoet spec type that can have a context receiver. */
public interface ContextReceivable {

  /** The originating elements of this type. */
  @ExperimentalKotlinPoetApi
  public val contextReceiverTypes: List

  /** The builder analogue to [ContextReceivable] types. */
  public interface Builder> {

    /** Mutable map of the current originating elements this builder contains. */
    @ExperimentalKotlinPoetApi
    public val contextReceiverTypes: MutableList

    /** Adds the given [receiverTypes] to this type's list of originating elements. */
    @Suppress("UNCHECKED_CAST")
    @ExperimentalKotlinPoetApi
    public fun contextReceivers(receiverTypes: Iterable): T = apply {
      contextReceiverTypes += receiverTypes
    } as T

    /** Adds the given [receiverTypes] to this type's list of originating elements. */
    @ExperimentalKotlinPoetApi
    public fun contextReceivers(vararg receiverTypes: TypeName): T =
      contextReceivers(receiverTypes.toList())
  }
}

@ExperimentalKotlinPoetApi
internal fun ContextReceivable.Builder<*>.buildContextReceivers() =
  ContextReceivers(contextReceiverTypes.toImmutableList())

@JvmInline
@ExperimentalKotlinPoetApi
internal value class ContextReceivers(
  override val contextReceiverTypes: List,
) : ContextReceivable