0.0.1-SNAPSHOT

files/space.iseki.executables.common

Package-level declarations

Types

AccessDeniedException

expect class AccessDeniedException : IOException

actual typealias AccessDeniedException = java.nio.file.AccessDeniedException

actual class AccessDeniedException : IOException

@Serializable(with = Address32.Serializer::class)

value class Address32(val value: UInt) : Comparable<Address32>

Represents a 32-bit address in a PE file.

@Serializable(with = Address64.Serializer::class)

value class Address64(val value: ULong) : Comparable<Address64>

Represents a 64-bit address in a PE file.

CommonFileException

open class CommonFileException @JvmOverloads constructor(message: String? = null, cause: Throwable? = null) : RuntimeException

interface DataAccessor : AutoCloseable

Defines an interface for random-access data reading.

expect class EOFException(message: String?) : IOException

Represents an end-of-file exception.

actual typealias EOFException = java.io.EOFException

actual class EOFException(message: String?) : IOException

interface ExportSymbol : ReadableStructure

ExportSymbolContainer

interface ExportSymbolContainer

expect interface FileFormat<out T : OpenedFile>

Represents a object or executable file format.

actual interface FileFormat<out T : OpenedFile>

Represents a object or executable file format.

actual interface FileFormat<out T : OpenedFile>

Represents a object or executable file format.

actual interface FileFormat<out T : OpenedFile>

Represents a object or executable file format.

actual interface FileFormat<out T : OpenedFile>

Represents a object or executable file format.

actual interface FileFormat<out T : OpenedFile>

Represents a object or executable file format.

interface ImportSymbol : ReadableStructure

Represents an imported symbol in an executable file

ImportSymbolContainer

interface ImportSymbolContainer

Represents a container that holds import symbols

expect open class IOException(message: String?, cause: Throwable?) : Exception

Represents an I/O exception.

actual typealias IOException = java.io.IOException

actual open class IOException(message: String?, cause: Throwable?) : Exception

NoSuchFileException

expect class NoSuchFileException : IOException

actual typealias NoSuchFileException = java.nio.file.NoSuchFileException

actual class NoSuchFileException : IOException

interface OpenedFile : AutoCloseable

ReadableSection

interface ReadableSection : DataAccessor

Represents a section of a file that can be read.

ReadableSectionContainer

interface ReadableSectionContainer

ReadableStructure

interface ReadableStructure

Provides a way to read a simple structure object

SectionInputStream

class SectionInputStream(section: ReadableSection) : InputStream

An implementation of InputStream that reads data from a ReadableSection. This class provides a way to read section data using the standard Java InputStream API.

TimeDateStamp32

@Serializable(with = TimeDateStamp32.Serializer::class)

value class TimeDateStamp32(val value: UInt) : Comparable<TimeDateStamp32>

Represents a 32-bit time stamp in PE/COFF file format.

VirtualMemoryReadable

interface VirtualMemoryReadable

Functions

inline fun Address32(value: Int): Address32

Convert from raw value to 32-bit address.

inline fun Address64(value: Int): Address64

inline fun Address64(value: Long): Address64

inline fun Address64(value: UInt): Address64

fun FileFormat.Companion.detect(data: ByteArray): FileFormat<OpenedFile>?

Detects the type of the executable file from the provided ByteArray.

expect fun FileFormat.Companion.detect(path: String): FileFormat<OpenedFile>?

Detects the type of the executable file from the given path.

fun FileFormat.Companion.detect(dataAccessor: DataAccessor): FileFormat<OpenedFile>?

Detects the type of the executable file from the provided DataAccessor.

fun FileFormat.Companion.detect(file: File): FileFormat<OpenedFile>?

Detects the type of the executable file from the given file.

fun FileFormat.Companion.detect(path: Path): FileFormat<OpenedFile>?

actual fun FileFormat.Companion.detect(path: String): FileFormat<OpenedFile>?

Detects the type of the executable file from the given path.

actual fun FileFormat.Companion.detect(path: String): FileFormat<OpenedFile>?

Detects the type of the executable file from the given path.

actual fun FileFormat.Companion.detect(path: String): FileFormat<OpenedFile>?

Detects the type of the executable file from the given path.

actual fun FileFormat.Companion.detect(path: String): FileFormat<OpenedFile>?

Detects the type of the executable file from the given path.

actual fun FileFormat.Companion.detect(path: String): FileFormat<OpenedFile>?

Detects the type of the executable file from the given path.

fun FileFormat(name: String): FileFormat<*>

inline fun ReadableSection.inputStream(): InputStream

Extension function that creates an InputStream from a ReadableSection.

fun FileFormat<*>.isElf(): Boolean

Returns true if this is an ELF file.

fun FileFormat<*>.isMacho(): Boolean

Returns true if this is a Mach-O file.

fun FileFormat<*>.isPE(): Boolean

Returns true if this is a PE file.

inline fun DataAccessor.readAtMost(pos: Address32, buf: ByteArray): Int

Reads at most buf.size bytes from the data source starting at the 32-bit pos into the given buf.

inline fun DataAccessor.readAtMost(pos: Address64, buf: ByteArray): Int

Reads at most buf.size bytes from the data source starting at the 64-bit pos into the given buf.

inline fun DataAccessor.readAtMost(pos: Address32, buf: ByteArray, off: Int, len: Int): Int

inline fun DataAccessor.readAtMost(pos: Address64, buf: ByteArray, off: Int, len: Int): Int

Reads at most len bytes from the data source starting at the given pos into the buf array, starting at offset off.

inline fun DataAccessor.readFully(pos: Address32, buf: ByteArray)

Reads exactly buf.size bytes starting at the 32-bit pos into the buffer.

inline fun DataAccessor.readFully(pos: Address64, buf: ByteArray)

Reads exactly buf.size bytes starting at the 64-bit pos into the buffer.

inline fun DataAccessor.readFully(pos: Address32, buf: ByteArray, off: Int, len: Int)

Reads exactly len bytes starting at the 32-bit pos into buf, beginning at offset off.

inline fun DataAccessor.readFully(pos: Address64, buf: ByteArray, off: Int, len: Int)

Reads exactly len bytes starting at the 64-bit pos into buf, beginning at offset off.

inline fun Int.toAddr(): Address32

inline fun Long.toAddr(): Address64

inline fun UInt.toAddr(): Address32

inline fun ULong.toAddr(): Address64