org.jacodb.api.cfg.JcBlockGraph.kt Maven / Gradle / Ivy
Show all versions of jacodb-api Show documentation
/*
* 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
/**
* Basic block represents a list of instructions that:
* - guaranteed to execute one after other during normal control flow
* (i.e. no exceptions thrown)
* - all have the same exception handlers (i.e. `jcGraph.catchers(inst)`
* returns the same result for all instructions of the basic block)
*
* Because of the current implementation of basic block API, block is *not*
* guaranteed to end with a terminating (i.e. `JcTerminatingInst` or `JcBranchingInst`) instruction.
* However, any terminating instruction is guaranteed to be the last instruction of a basic block.
*/
data class JcBasicBlock(val start: JcInstRef, val end: JcInstRef) {
fun contains(inst: JcInst): Boolean {
return inst.location.index <= end.index && inst.location.index >= start.index
}
fun contains(inst: JcInstRef): Boolean {
return inst.index <= end.index && inst.index >= start.index
}
}
interface JcBlockGraph : JcBytecodeGraph {
val jcGraph: JcGraph
val entry: JcBasicBlock
override val exits: List
fun instructions(block: JcBasicBlock): List
fun block(inst: JcInst): JcBasicBlock
/**
* `successors` and `predecessors` represent normal control flow
*/
override fun predecessors(node: JcBasicBlock): Set
override fun successors(node: JcBasicBlock): Set
/**
* `throwers` and `catchers` represent control flow when an exception occurs
*/
override fun catchers(node: JcBasicBlock): Set
override fun throwers(node: JcBasicBlock): Set
}