org.jetbrains.kotlin.contracts.model.Functor.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler Show documentation

Kotlin Compiler

There is a newer version: 2.0.0

/*
 * Copyright 2010-2017 JetBrains s.r.o.
 *
 * 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 org.jetbrains.kotlin.contracts.model

import org.jetbrains.kotlin.contracts.model.structure.ESKotlinType
import org.jetbrains.kotlin.contracts.model.visitors.Reducer

/**
 * An abstraction of effect-generating nature of some computation.
 *
 * One can think of Functor as of adjoint to function declaration, responsible
 * for generating effects. It's [invokeWithArguments] method roughly corresponds
 * to call of corresponding function, but instead of taking values and returning
 * values, it takes effects and returns effects.
 */
interface Functor {
    fun invokeWithArguments(arguments: List, typeSubstitution: ESTypeSubstitution, reducer: Reducer): List
}


abstract class AbstractFunctor : Functor {
    override fun invokeWithArguments(arguments: List, typeSubstitution: ESTypeSubstitution, reducer: Reducer): List =
        reducer.reduceEffects(doInvocation(arguments, typeSubstitution, reducer))

    protected abstract fun doInvocation(
        arguments: List,
        typeSubstitution: ESTypeSubstitution,
        reducer: Reducer
    ): List
}

typealias ESTypeSubstitution = Map