org.jacodb.api.cfg.JcGraph.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jacodb-api Show documentation

analyse JVM bytecode with pleasure

There is a newer version: 1.4.5

/*
 *  Copyright 2022 UnitTestBot contributors (utbot.org)
 * 
 *  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.jacodb.api.cfg

import org.jacodb.api.JcClassType
import org.jacodb.api.JcClasspath
import org.jacodb.api.JcMethod

interface JcGraph : JcBytecodeGraph {

    val method: JcMethod
    val classpath: JcClasspath
    val instructions: List
    val entry: JcInst
    override val exits: List
    override val entries: List
        get() = if (instructions.isEmpty()) listOf() else listOf(entry)

    /**
     * returns a map of possible exceptions that may be thrown from this method
     * for each instruction of in the graph in determines possible thrown exceptions using
     * #JcExceptionResolver class
     */
    val throwExits: Map>

    fun index(inst: JcInst): Int
    fun ref(inst: JcInst): JcInstRef
    fun inst(ref: JcInstRef): JcInst
    fun previous(inst: JcInst): JcInst
    fun next(inst: JcInst): JcInst

    /**
     * `successors` and `predecessors` represent normal control flow
     */
    override fun successors(node: JcInst): Set
    override fun predecessors(node: JcInst): Set

    /**
     * `throwers` and `catchers` represent control flow when an exception occurs
     * `throwers` returns an empty set for every instruction except `JcCatchInst`
     */
    override fun throwers(node: JcInst): Set
    override fun catchers(node: JcInst): Set
    fun previous(inst: JcInstRef): JcInst
    fun next(inst: JcInstRef): JcInst
    fun successors(inst: JcInstRef): Set
    fun predecessors(inst: JcInstRef): Set
    fun throwers(inst: JcInstRef): Set
    fun catchers(inst: JcInstRef): Set

    /**
     * get all the exceptions types that this instruction may throw and terminate
     * current method
     */
    fun exceptionExits(inst: JcInst): Set
    fun exceptionExits(ref: JcInstRef): Set
    fun blockGraph(): JcBlockGraph
}