Jimulator Namespace Reference

Groups together functions that make up the Jimulator API layer - these functions and classes are used for sending and receiving information from the emulator. More...

Classes
class	MemoryValues
	A class that returns all of the information associated with a single row of a memory window, as read from Jimulator. More...

Functions
const ClientState	checkBoardState ()
	Check the state of the board - logs what it is doing. More...
const std::array< std::string, 16 >	getJimulatorRegisterValues ()
	Queries a register in Jimulator to get it's current value. More...
std::array< Jimulator::MemoryValues, 13 >	getJimulatorMemoryValues (const uint32_t s_address_int)
	Get the memory values from Jimulator, starting to s_address. More...
const std::string	getJimulatorTerminalMessages ()
	Reads for messages from Jimulator, to display in the terminal output. More...
void	compileJimulator (std::string pathToBin, const char *const pathToS, const char *const pathToKMD)
	Runs pathToS through the associated compiler binary, and outputs a .kmd file at pathToKMD. More...
const bool	loadJimulator (const char *const pathToKMD)
	Clears the existing source object and loads the file at pathToKMD into Jimulator. More...
void	startJimulator (const int steps)
	Commences running the emulator. More...
void	continueJimulator ()
	Continues running Jimulator.
void	pauseJimulator ()
	Pauses the emulator running.
void	resetJimulator ()
	Reset the emulators running.
const bool	sendTerminalInputToJimulator (const unsigned int val)
	Sends terminal information to Jimulator. More...
const bool	setBreakpoint (const uint32_t address)
	Sets a breakpoint. More...
void	compileJimulator (const char *const pathToBin, const char *const pathToS, const char *const pathToKMD)
	Runs pathToS through the associated compiler binary, and outputs a .kmd file at pathToKMD. More...

Detailed Description

Groups together functions that make up the Jimulator API layer - these functions and classes are used for sending and receiving information from the emulator.

Function Documentation

const ClientState Jimulator::checkBoardState

(

)

Check the state of the board - logs what it is doing.

Returns

int 0 if the board is in a failed state, else a number greater than 0.

Definition at line 422 of file kcmd.cpp.

void Jimulator::compileJimulator	(	std::string	pathToBin,
		const char *const	pathToS,
		const char *const	pathToKMD
	)

Runs pathToS through the associated compiler binary, and outputs a .kmd file at pathToKMD.

Parameters

pathToBin	An absolute path to the aasm binary.
pathToS	An absolute path to the .s file to be compiled.
pathToKMD	an absolute path to the .kmd file that will be output.

Definition at line 283 of file kcmd.cpp.

void Jimulator::compileJimulator	(	const char *const	pathToBin,
		const char *const	pathToS,
		const char *const	pathToKMD
	)

Runs pathToS through the associated compiler binary, and outputs a .kmd file at pathToKMD.

Parameters

pathToBin	An absolute path to the aasm binary.
pathToS	An absolute path to the .s file to be compiled.
pathToKMD	an absolute path to the .kmd file that will be output.

Definition at line 269 of file jimulatorInterface.cpp.

std::array< Jimulator::MemoryValues, 13 > Jimulator::getJimulatorMemoryValues

(

const uint32_t

s_address_int

)

Get the memory values from Jimulator, starting to s_address.

Parameters

s_address

The address to start at, as an integer.

Returns

std::array<Jimulator::MemoryValues, 13> An array of all of the values read from Jimulator, including each column.

Definition at line 525 of file kcmd.cpp.

const std::array< std::string, 16 > Jimulator::getJimulatorRegisterValues

(

)

Queries a register in Jimulator to get it's current value.

Returns

The values read from the registers.

Definition at line 453 of file kcmd.cpp.

const std::string Jimulator::getJimulatorTerminalMessages

(

)

Reads for messages from Jimulator, to display in the terminal output.

Returns

const std::string The message to be displayed in the terminal output.

Definition at line 470 of file kcmd.cpp.

const bool Jimulator::loadJimulator

(

const char *const

pathToKMD

)

Clears the existing source object and loads the file at pathToKMD into Jimulator.

Parameters

pathToKMD

an absolute path to the .kmd file that will be loaded.

Returns

Definition at line 326 of file kcmd.cpp.

const bool Jimulator::sendTerminalInputToJimulator

(

const unsigned int

val

)

Sends terminal information to Jimulator.

Parameters

val	A key code.

Returns

true If the key was sent to Jimulator successfully.

false If the key was not sent to Jimulator successfully.

Definition at line 499 of file kcmd.cpp.

const bool Jimulator::setBreakpoint

(

const uint32_t

address

)

Sets a breakpoint.

Parameters

addr	The address to set the breakpoint at.

Returns

const bool If setting the breakpoint succeeded.

Definition at line 372 of file kcmd.cpp.

void Jimulator::startJimulator

(

const int

steps

)

Commences running the emulator.

Parameters

steps

The number of steps to run for (0 for indefinite)

Definition at line 335 of file kcmd.cpp.