aboutsummaryrefslogtreecommitdiff
path: root/api/src/main/kotlin/com/google/devtools/ksp/symbol/KSFunction.kt
blob: d4139dbbe22a43721961121539ed4d48dfa438f2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*
 * Copyright 2020 Google LLC
 * Copyright 2010-2020 JetBrains s.r.o. and Kotlin Programming Language contributors.
 *
 * 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.google.devtools.ksp.symbol
import com.google.devtools.ksp.processing.Resolver
/**
 * Holds the information for a [KSFunctionDeclaration] where type arguments are resolved as member
 * of a specific [KSType].
 *
 * @see Resolver.asMemberOf
 */
interface KSFunction {
    /**
     * The return type of the function. Note that this might be `null` if an error happened when
     * the type is resolved.
     *
     * @see KSFunctionDeclaration.returnType
     */
    val returnType: KSType?

    /**
     * The types of the value parameters of the function. Note that this list might have `null`
     * values in it if the type of a parameter could not be resolved.
     *
     * @see KSFunctionDeclaration.parameters
     */
    val parameterTypes: List<KSType?>

    /**
     * The type parameters of the function.
     *
     * @see KSFunctionDeclaration.typeParameters
     */
    val typeParameters: List<KSTypeParameter>

    /**
     * The receiver type of the function.
     *
     * @see KSFunctionDeclaration.extensionReceiver
     */
    val extensionReceiverType: KSType?

    /**
     * True if the compiler couldn't resolve the function.
     */
    val isError: Boolean
}