library/ir.alisalimik.kotstone.api/CapstoneEngine

CapstoneEngine

class CapstoneEngine : AutoCloseable(source)

Main Capstone disassembly engine.

This is the primary interface for disassembling machine code. Use the build factory method to create instances with configuration.

The engine must be closed after use to release resources. Use the use extension function for automatic resource management:

CapstoneEngine.build(Architecture.ARM64, Mode.LITTLE_ENDIAN) {
    detail = true
    syntax = Syntax.DEFAULT
}.use { engine ->
    val result = engine.disassemble(bytes, address = 0x1000)
    result.onSuccess { instructions ->
        instructions.forEach { println(it) }
    }
}

Types

object Companion

Properties

val architecture: Architecture

Target architecture being disassembled

val mode: BitField<Mode>

Disassembly mode flags

Functions

open override fun close()

Close the engine and release resources.

fun disassemble(code: ByteArray, address: Long = 0, count: Int = 0): CapstoneResult<List<Instruction>>

Disassemble binary code.

fun disassembleOne(code: ByteArray, position: DisassemblyPosition): CapstoneResult<Instruction?>

Disassemble single instruction at current position.

fun groupName(groupId: Int): String?

Get the friendly name of an instruction group.

instructionName

fun instructionName(insnId: Int): String?

Get the friendly name of an instruction.

fun iterate(code: ByteArray, address: Long = 0): DisassemblyIterator

Create an iterator for memory-efficient disassembly.

fun lastError(): ErrorCode

Get the last error code from the engine.

fun registerName(regId: Int): String?

Get the friendly name of a register.

fun setOption(option: CapstoneOption): CapstoneResult<Unit>

Set a runtime option.