GuardsAPI

#include <VirtualC64.h>

class GuardsAPI

Defined in VirtualC64.h:240

Guards API

Gives access to one list of guards (the breakpoints or the watchpoints of the CPU). The functions that modify the list come in two flavors, following the usual scheme of the API:

• The plain functions (e.g., setAt()) return when the emulator thread has carried out the request. A failure throws the corresponding exception (e.g., if a guard to remove does not exist). They throw CoreError (CoreError::NOT_LAUNCHED) if the emulator thread cannot carry out the request, because it has not been launched yet, is halted or suspended, or if they are called from the emulator thread itself.
• The functions with the Async suffix (e.g., setAtAsync()) queue the request and return at once. A failure is not reported to the caller. The change shows up in the query functions only after the emulator thread has carried it out (see sync()).

Public Methods

Return	Name	Description
isize	elements const	Returns the number of guards in the guard list.
std::optional< GuardInfo >	guardNr const	Returns information about a guard.
std::optional< GuardInfo >	guardAt const	Returns information about a guard.
void	setAt	Sets a guard.
void	setAtAsync	Asynchronous version of setAt(): queues the request and returns at once.
void	moveTo	Relocates a guard.
void	moveToAsync	Asynchronous version of moveTo(): queues the request and returns at once.
void	remove	Deletes a guard.
void	removeAsync	Asynchronous version of remove(): queues the request and returns at once.
void	removeAt	Deletes a guard.
void	removeAtAsync	Asynchronous version of removeAt(): queues the request and returns at once.
void	removeAll	Deletes all guards.
void	removeAllAsync	Asynchronous version of removeAll(): queues the request and returns at once.
void	enable	Enables a guard.
void	enableAsync	Asynchronous version of enable(): queues the request and returns at once.
void	enableAt	Enables a guard.
void	enableAtAsync	Asynchronous version of enableAt(): queues the request and returns at once.
void	enableAll	Enables all guards.
void	enableAllAsync	Asynchronous version of enableAll(): queues the request and returns at once.
void	disable	Disables a guard.
void	disableAsync	Asynchronous version of disable(): queues the request and returns at once.
void	disableAt	Disables a guard.
void	disableAtAsync	Asynchronous version of disableAt(): queues the request and returns at once.
void	disableAll	Disables all guards.
void	disableAllAsync	Asynchronous version of disableAll(): queues the request and returns at once.
void	toggle	Enables a disabled guard and disables an enabled one.
void	toggleAsync	Asynchronous version of toggle(): queues the request and returns at once.

---

elements

const

isize elements() const

Defined in VirtualC64.h:253

Returns the number of guards in the guard list.

---

guardNr

const

std::optional< GuardInfo > guardNr(isize nr) const

Defined in VirtualC64.h:259

Returns information about a guard.

Returns

A copy of the guard's state, or nothing if it does not exist.

Parameters

Parameter	Type	Description
nr	isize	Number of the guard in the guard list

---

guardAt

const

std::optional< GuardInfo > guardAt(u32 target) const

Defined in VirtualC64.h:265

Returns information about a guard.

Returns

A copy of the guard's state, or nothing if the target is not guarded.

Parameters

Parameter	Type	Description
target	u32	The target of the guard to query

---

setAt

void setAt(u32 target, isize ignores = 0)

Defined in VirtualC64.h:271

Sets a guard.

Parameters

Parameter	Type	Description
target	u32	The observed memory address (the target of the guard).
ignores	isize	If a value greater zero is given, the guard has to be hit the specified number of times until program execution is paused.

---

setAtAsync

void setAtAsync(u32 target, isize ignores = 0)

Defined in VirtualC64.h:274

Asynchronous version of setAt(): queues the request and returns at once.

---

moveTo

void moveTo(isize nr, u32 target)

Defined in VirtualC64.h:280

Relocates a guard.

Parameters

Parameter	Type	Description
nr	isize	Number of the guard in the guard list
target	u32	New target

---

moveToAsync

void moveToAsync(isize nr, u32 target)

Defined in VirtualC64.h:283

Asynchronous version of moveTo(): queues the request and returns at once.

---

remove

void remove(isize nr)

Defined in VirtualC64.h:288

Deletes a guard.

Parameters

Parameter	Type	Description
nr	isize	Number of the guard in the guard list

---

removeAsync

void removeAsync(isize nr)

Defined in VirtualC64.h:291

Asynchronous version of remove(): queues the request and returns at once.

---

removeAt

void removeAt(u32 target)

Defined in VirtualC64.h:296

Deletes a guard.

Parameters

Parameter	Type	Description
target	u32	The target of the guard to be deleted.

---

removeAtAsync

void removeAtAsync(u32 target)

Defined in VirtualC64.h:299

Asynchronous version of removeAt(): queues the request and returns at once.

---

removeAll

void removeAll()

Defined in VirtualC64.h:303

Deletes all guards.

---

removeAllAsync

void removeAllAsync()

Defined in VirtualC64.h:306

Asynchronous version of removeAll(): queues the request and returns at once.

---

enable

void enable(isize nr)

Defined in VirtualC64.h:311

Enables a guard.

Parameters

Parameter	Type	Description
nr	isize	Number of the guard in the guard list

---

enableAsync

void enableAsync(isize nr)

Defined in VirtualC64.h:314

Asynchronous version of enable(): queues the request and returns at once.

---

enableAt

void enableAt(u32 target)

Defined in VirtualC64.h:319

Enables a guard.

Parameters

Parameter	Type	Description
target	u32	The target of the guard to be enabled

---

enableAtAsync

void enableAtAsync(u32 target)

Defined in VirtualC64.h:322

Asynchronous version of enableAt(): queues the request and returns at once.

---

enableAll

void enableAll()

Defined in VirtualC64.h:326

Enables all guards.

---

enableAllAsync

void enableAllAsync()

Defined in VirtualC64.h:329

Asynchronous version of enableAll(): queues the request and returns at once.

---

disable

void disable(isize nr)

Defined in VirtualC64.h:334

Disables a guard.

Parameters

Parameter	Type	Description
nr	isize	Number of the guard in the guard list

---

disableAsync

void disableAsync(isize nr)

Defined in VirtualC64.h:337

Asynchronous version of disable(): queues the request and returns at once.

---

disableAt

void disableAt(u32 target)

Defined in VirtualC64.h:342

Disables a guard.

Parameters

Parameter	Type	Description
target	u32	The target of the guard to be disabled

---

disableAtAsync

void disableAtAsync(u32 target)

Defined in VirtualC64.h:345

Asynchronous version of disableAt(): queues the request and returns at once.

---

disableAll

void disableAll()

Defined in VirtualC64.h:349

Disables all guards.

---

disableAllAsync

void disableAllAsync()

Defined in VirtualC64.h:352

Asynchronous version of disableAll(): queues the request and returns at once.

---

toggle

void toggle(isize nr)

Defined in VirtualC64.h:357

Enables a disabled guard and disables an enabled one.

Parameters

Parameter	Type	Description
nr	isize	Number of the guard in the guard list

---

toggleAsync

void toggleAsync(isize nr)

Defined in VirtualC64.h:360

Asynchronous version of toggle(): queues the request and returns at once.