fcml::AssemblerResult Class Reference

Assembler result. More...

#include <fcml_assembler.hpp>

Public Member Functions
	AssemblerResult ()
const AssembledInstruction *	getChosenInstruction () const
	Gets instruction chosen by the assembler as the preferred one.
const ErrorContainer &	getErrorContainer () const
	Gets errors container.
fcml_usize	getSize () const
	Gets number of instructions alternatives available in the result.
	operator const AssembledInstruction * () const
	Gets pointer to the chosen instruction.
const AssembledInstruction &	operator[] (fcml_usize index) const
	Gets an assembled instruction reference by its index.
void	clear ()
	Clears assembler result by removing all assembled instructions, errors and reseting the chosen instruction.

Protected Member Functions
void	setErrorContainer (const ErrorContainer &errorContainer)
std::vector< AssembledInstruction > &	getAssembledInstructions ()
void	setChoosenInstructionIndex (fcml_int index)

Protected Attributes
friend	Assembler

Friends
std::basic_ostream< fcml_uint8_t > &	operator<< (std::basic_ostream< fcml_uint8_t > &out, const AssemblerResult &result)
	Copies machine code of the chosen instruction to the output stream.

Detailed Description

Assembler result.

Constructor & Destructor Documentation

AssemblerResult()

fcml::AssemblerResult::AssemblerResult ( )

inline

Since

1.1.0

Member Function Documentation

clear()

void fcml::AssemblerResult::clear ( )

inline

Clears assembler result by removing all assembled instructions, errors and reseting the chosen instruction.

Since

1.1.0

getChosenInstruction()

const AssembledInstruction * fcml::AssemblerResult::getChosenInstruction ( ) const

inline

Gets instruction chosen by the assembler as the preferred one.

Returns

Preferred instruction.

Since

1.1.0

getErrorContainer()

const ErrorContainer & fcml::AssemblerResult::getErrorContainer ( ) const

inline

Gets errors container.

Returns

Errors container.

Since

1.1.0

getSize()

fcml_usize fcml::AssemblerResult::getSize ( ) const

inline

Gets number of instructions alternatives available in the result.

Returns

Number of available instructions.

Since

1.1.0

operator const AssembledInstruction *()

fcml::AssemblerResult::operator const AssembledInstruction * ( ) const

inline

Gets pointer to the chosen instruction.

Returns

Pointer to the chosen instruction.

Since

1.1.0

operator[]()

const AssembledInstruction & fcml::AssemblerResult::operator[] ( fcml_usize index ) const

inline

Gets an assembled instruction reference by its index.

Returns

The assembled instruction for given index.

Exceptions

BadArgumentException

Array index out of bound.

Since

1.1.0

Friends And Related Symbol Documentation

operator<<

std::basic_ostream< fcml_uint8_t > & operator<< ( std::basic_ostream< fcml_uint8_t > & out, const AssemblerResult & result )

friend

Copies machine code of the chosen instruction to the output stream.

Parameters

[out]	out	Output stream.
	result	Assembler result.

Returns

Output stream from the parameter.

Since

1.1.0

---

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

• include/fcml_assembler.hpp