This class is just a helper to. More...

#include <BytecodeReader.hpp>

Collaboration diagram for Ark::BytecodeReader:

Public Member Functions
	BytecodeReader ()
	Construct a new Bytecode Reader object.

void	feed (const std::string &file)
	Construct needed data before displaying information about a given file.

void	feed (const bytecode_t &bytecode)
	Construct needed data before displaying information about a given bytecode.

bool	checkMagic () const

Version	version () const

unsigned long long	timestamp () const
	Return the read timestamp from the bytecode file.

std::vector< unsigned char >	sha256 () const

Symbols	symbols () const

Values	values (const Symbols &symbols) const

Filenames	filenames (const Values &values) const

InstLocations	instLocations (const Filenames &filenames) const

Code	code (const InstLocations &instLocations) const

std::optional< internal::InstLoc >	findSourceLocation (const std::vector< internal::InstLoc > &inst_locations, std::size_t ip, std::size_t pp) const
	Find the location of an instruction.

void	display (BytecodeSegment segment=BytecodeSegment::All, std::optional< uint16_t > sStart=std::nullopt, std::optional< uint16_t > sEnd=std::nullopt, std::optional< uint16_t > cPage=std::nullopt) const
	Display the bytecode opcode in a human friendly way.

void	printInstruction (std::ostream &os, uint8_t inst, uint8_t padding, uint16_t imm_arg, const Symbols &syms, const Values &vals, bool colorize=true) const

Private Member Functions
uint16_t	readNumber (std::size_t &i) const
	Read a number from the bytecode, under the instruction pointer i.

Private Attributes
bytecode_t	m_bytecode

std::unordered_map< internal::Instruction, internal::ArgKind >	m_arg_kinds

Friends
class	Ark::State

Detailed Description

This class is just a helper to.

check if a bytecode is valid
display it in a human-readable way by using the opcode names

Definition at line 126 of file BytecodeReader.hpp.

Constructor & Destructor Documentation

◆ BytecodeReader()

Ark::BytecodeReader::BytecodeReader ( )

Construct a new Bytecode Reader object.

Definition at line 18 of file BytecodeReader.cpp.

References m_arg_kinds.

Member Function Documentation

◆ checkMagic()

bool Ark::BytecodeReader::checkMagic ( ) const

nodiscard

Check for the presence of the magic header

Returns: true if the magic 'ark\0' was found

Definition at line 128 of file BytecodeReader.cpp.

References m_bytecode, and Ark::internal::bytecode::Magic.

Referenced by code(), display(), Ark::State::doFile(), Ark::State::feed(), filenames(), instLocations(), main(), sha256(), symbols(), timestamp(), values(), and version().

◆ code()

Code Ark::BytecodeReader::code ( const InstLocations & instLocations ) const

nodiscard

Parameters

instLocations

Returns: Code

Definition at line 335 of file BytecodeReader.cpp.

References checkMagic(), Ark::internal::CODE_SEGMENT_START, Ark::InstLocations::end, instLocations(), m_bytecode, Ark::Code::pages, readNumber(), and Ark::Code::start.

Referenced by Ark::internal::Debugger::compile(), Ark::State::configure(), and display().

◆ display()

void Ark::BytecodeReader::display	(	BytecodeSegment	segment = BytecodeSegment::All,
		std::optional< uint16_t >	sStart = std::nullopt,
		std::optional< uint16_t >	sEnd = std::nullopt,
		std::optional< uint16_t >	cPage = std::nullopt ) const

Display the bytecode opcode in a human friendly way.

Parameters

segment	selected bytecode segment that will be displayed
sStart	start of the segment slice to display (Ignored in code segment if no page is available)
sEnd	end of the segment slice to display (Ignored in code segment if no page is available)
cPage	selected page of the code segment (Used only for the code segment)

Definition at line 385 of file BytecodeReader.cpp.

References Ark::All, checkMagic(), Ark::Code, code(), filenames(), findSourceLocation(), Ark::HeadersOnly, instLocations(), Ark::InstructionLocation, Ark::Number, Ark::PageAddr, printInstruction(), sha256(), Ark::String, Ark::Symbols, symbols(), timestamp(), std::to_string(), Ark::Values, values(), and version().

Referenced by main().

◆ feed() [1/2]

void Ark::BytecodeReader::feed ( const bytecode_t & bytecode )

Construct needed data before displaying information about a given bytecode.

Parameters

bytecode

Definition at line 105 of file BytecodeReader.cpp.

References m_bytecode.

◆ feed() [2/2]

void Ark::BytecodeReader::feed ( const std::string & file )

Construct needed data before displaying information about a given file.

Parameters

file	filename of the bytecode file

Definition at line 110 of file BytecodeReader.cpp.

References m_bytecode.

Referenced by Ark::internal::Debugger::compile(), Ark::State::doFile(), Ark::State::feed(), main(), and Ark::internal::Debugger::showPreviousInstructions().

◆ filenames()

Filenames Ark::BytecodeReader::filenames ( const Values & values ) const

nodiscard

Parameters

values

Returns: Filenames

Definition at line 262 of file BytecodeReader.cpp.

References checkMagic(), Ark::Filenames::end, Ark::Values::end, Ark::Filenames::filenames, Ark::internal::FILENAMES_TABLE_START, m_bytecode, readNumber(), Ark::Filenames::start, and values().

Referenced by Ark::internal::Debugger::compile(), Ark::State::configure(), display(), and instLocations().

◆ findSourceLocation()

std::optional< InstLoc > Ark::BytecodeReader::findSourceLocation	(	const std::vector< internal::InstLoc > &	inst_locations,
		std::size_t	ip,
		std::size_t	pp ) const

Find the location of an instruction.

Parameters

inst_locations
ip
pp

Returns

Definition at line 362 of file BytecodeReader.cpp.

Referenced by display().

◆ instLocations()

InstLocations Ark::BytecodeReader::instLocations ( const Filenames & filenames ) const

nodiscard

Parameters

filenames

Returns: InstLocations

Definition at line 292 of file BytecodeReader.cpp.

References checkMagic(), Ark::internal::deserializeBE(), Ark::Filenames::end, Ark::InstLocations::end, filenames(), Ark::internal::INST_LOC_TABLE_START, Ark::InstLocations::locations, m_bytecode, readNumber(), and Ark::InstLocations::start.

Referenced by code(), Ark::internal::Debugger::compile(), Ark::State::configure(), and display().

◆ printInstruction()

void Ark::BytecodeReader::printInstruction	(	std::ostream &	os,
		uint8_t	inst,
		uint8_t	padding,
		uint16_t	imm_arg,
		const Symbols &	syms,
		const Values &	vals,
		bool	colorize = true ) const

Definition at line 612 of file BytecodeReader.cpp.

References Ark::internal::Builtins::builtins, Ark::internal::InstructionNames, m_arg_kinds, Ark::Number, Ark::PageAddr, Ark::String, Ark::Symbols::symbols, Ark::Values::values, and Ark::withForeColor().

Referenced by display(), and Ark::internal::Debugger::showPreviousInstructions().

◆ readNumber()

uint16_t Ark::BytecodeReader::readNumber ( std::size_t & i ) const

nodiscardprivate

Read a number from the bytecode, under the instruction pointer i.

Parameters

i	this parameter is being modified to point to the next value

Returns: uint16_t the number we read (big endian)

Definition at line 598 of file BytecodeReader.cpp.

References m_bytecode.

Referenced by code(), filenames(), instLocations(), symbols(), and values().

◆ sha256()

std::vector< unsigned char > Ark::BytecodeReader::sha256 ( ) const

nodiscard

Returns: std::vector<unsigned char> bytecode sha

Definition at line 167 of file BytecodeReader.cpp.

References checkMagic(), Ark::internal::bytecode::HeaderSize, and m_bytecode.

Referenced by Ark::State::configure(), and display().

◆ symbols()

Symbols Ark::BytecodeReader::symbols ( ) const

nodiscard

Returns: Symbols

Definition at line 178 of file BytecodeReader.cpp.

References checkMagic(), Ark::Symbols::end, Ark::internal::bytecode::HeaderSize, m_bytecode, readNumber(), Ark::Symbols::start, Ark::internal::SYM_TABLE_START, and Ark::Symbols::symbols.

Referenced by Ark::internal::Debugger::compile(), Ark::State::configure(), display(), Ark::internal::Debugger::showPreviousInstructions(), and values().

◆ timestamp()

unsigned long long Ark::BytecodeReader::timestamp ( ) const

nodiscard

Return the read timestamp from the bytecode file.

Returns: unsigned long long

Definition at line 149 of file BytecodeReader.cpp.

References checkMagic(), Ark::internal::bytecode::HeaderSize, and m_bytecode.

Referenced by display().

◆ values()

Values Ark::BytecodeReader::values ( const Symbols & symbols ) const

nodiscard

Parameters

symbols

Returns: Values

Definition at line 206 of file BytecodeReader.cpp.

References checkMagic(), Ark::internal::ieee754::deserialize(), Ark::internal::deserializeLE(), Ark::Symbols::end, Ark::Values::end, Ark::internal::FUNC_TYPE, m_bytecode, Ark::internal::NUMBER_TYPE, readNumber(), Ark::Values::start, Ark::internal::STRING_TYPE, symbols(), Ark::internal::VAL_TABLE_START, and Ark::Values::values.

Referenced by Ark::internal::Debugger::compile(), Ark::State::configure(), display(), filenames(), and Ark::internal::Debugger::showPreviousInstructions().

◆ version()

Version Ark::BytecodeReader::version ( ) const

nodiscard

Returns: Version compiler version used to create the given bytecode file

Definition at line 137 of file BytecodeReader.cpp.

References checkMagic(), m_bytecode, Ark::internal::bytecode::Magic, and Ark::internal::bytecode::Version.

Referenced by Ark::State::configure(), and display().

Friends And Related Symbol Documentation

◆ Ark::State

friend class Ark::State

friend

Definition at line 228 of file BytecodeReader.hpp.

Member Data Documentation

◆ m_arg_kinds

std::unordered_map<internal::Instruction, internal::ArgKind> Ark::BytecodeReader::m_arg_kinds

private

Definition at line 232 of file BytecodeReader.hpp.

Referenced by BytecodeReader(), and printInstruction().

◆ m_bytecode

bytecode_t Ark::BytecodeReader::m_bytecode

private

Definition at line 231 of file BytecodeReader.hpp.

Referenced by checkMagic(), code(), feed(), feed(), filenames(), instLocations(), readNumber(), sha256(), symbols(), timestamp(), values(), and version().

The documentation for this class was generated from the following files:

/Users/fola/Documents/ArkScript/Ark/include/Ark/Compiler/BytecodeReader.hpp
/Users/fola/Documents/ArkScript/Ark/src/arkreactor/Compiler/BytecodeReader.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BytecodeReader()

Member Function Documentation

◆ checkMagic()

◆ code()

◆ display()

◆ feed() [1/2]

◆ feed() [2/2]

◆ filenames()

◆ findSourceLocation()

◆ instLocations()

◆ printInstruction()

◆ readNumber()

◆ sha256()

◆ symbols()

◆ timestamp()

◆ values()

◆ version()

Friends And Related Symbol Documentation

◆ Ark::State

Member Data Documentation

◆ m_arg_kinds

◆ m_bytecode