Tidied structure of all classes within the entire code base

Also some other small bits of tidying
This commit is contained in:
Nav
2021-10-06 21:12:31 +01:00
parent 1aef5bba79
commit 6edfb7376a
179 changed files with 3446 additions and 3493 deletions

View File

@@ -20,8 +20,6 @@
#include "src/EventManager/EventListener.hpp"
#include "src/EventManager/Events/Events.hpp"
#include "src/Logger/Logger.hpp"
namespace Bloom
{
/**
@@ -35,6 +33,22 @@ namespace Bloom
*/
class TargetController: public Thread
{
public:
explicit TargetController(EventManager& eventManager): eventManager(eventManager) {};
void setApplicationConfig(const ApplicationConfig& applicationConfig) {
this->applicationConfig = applicationConfig;
}
void setEnvironmentConfig(const EnvironmentConfig& environmentConfig) {
this->environmentConfig = environmentConfig;
}
/**
* Entry point for the TargetController.
*/
void run();
private:
/**
* The TC starts off in a suspended state. TargetController::resume() is invoked from the startup routine.
@@ -180,6 +194,11 @@ namespace Bloom
);
}
/**
* Because the TargetController hogs the thread, this method must be called in a dedicated thread.
*/
void startup();
/**
* Installs Bloom's udev rules on user's machine. Rules are copied from build/Distribution/Resources/UdevRules
* to /etc/udev/rules.d/. This method will report an error if Bloom isn't running as root (as root privileges
@@ -187,11 +206,6 @@ namespace Bloom
*/
static void checkUdevRules();
/**
* Because the TargetController hogs the thread, this method must be called in a dedicated thread.
*/
void startup();
/**
* Exit point - must be called before the TargetController thread is terminated.
*
@@ -199,17 +213,6 @@ namespace Bloom
*/
void shutdown();
/**
* Establishes a connection with the debug tool and target. Prepares the hardware for a debug session.
*/
void acquireHardware();
/**
* Attempts to gracefully disconnect from the debug tool and the target. All control of the debug tool and
* target will cease.
*/
void releaseHardware();
/**
* Puts the TargetController into the suspended state.
*
@@ -222,6 +225,17 @@ namespace Bloom
*/
void resume();
/**
* Establishes a connection with the debug tool and target. Prepares the hardware for a debug session.
*/
void acquireHardware();
/**
* Attempts to gracefully disconnect from the debug tool and the target. All control of the debug tool and
* target will cease.
*/
void releaseHardware();
/**
* Extracts address ranges and groups target register descriptors.
*/
@@ -257,21 +271,12 @@ namespace Bloom
Targets::TargetDescriptor& getTargetDescriptor();
public:
explicit TargetController(EventManager& eventManager): eventManager(eventManager) {};
void setApplicationConfig(const ApplicationConfig& applicationConfig) {
this->applicationConfig = applicationConfig;
}
void setEnvironmentConfig(const EnvironmentConfig& environmentConfig) {
this->environmentConfig = environmentConfig;
}
/**
* Entry point for the TargetController.
* Invokes a shutdown.
*
* @param event
*/
void run();
void onShutdownTargetControllerEvent(const Events::ShutdownTargetController& event);
/**
* Reports the current state of the TargetController.
@@ -287,6 +292,20 @@ namespace Bloom
*/
void onExtractTargetDescriptor(const Events::ExtractTargetDescriptor& event);
/**
* Will hold the target stopped at it's current state.
*
* @param event
*/
void onDebugSessionStartedEvent(const Events::DebugSessionStarted& event);
/**
* Will simply kick off execution on the target.
*
* @param event
*/
void onDebugSessionFinishedEvent(const Events::DebugSessionFinished& event);
/**
* Will attempt to stop execution on the target and emit a TargetExecutionStopped event.
*
@@ -308,13 +327,6 @@ namespace Bloom
*/
void onResumeTargetExecutionEvent(const Events::ResumeTargetExecution& event);
/**
* Invokes a shutdown.
*
* @param event
*/
void onShutdownTargetControllerEvent(const Events::ShutdownTargetController& event);
/**
* Will attempt to read the requested registers and emit a RegistersRetrievedFromTarget event.
*
@@ -359,20 +371,6 @@ namespace Bloom
*/
void onRemoveBreakpointEvent(const Events::RemoveBreakpointOnTarget& event);
/**
* Will hold the target stopped at it's current state.
*
* @param event
*/
void onDebugSessionStartedEvent(const Events::DebugSessionStarted& event);
/**
* Will simply kick off execution on the target.
*
* @param event
*/
void onDebugSessionFinishedEvent(const Events::DebugSessionFinished& event);
/**
* Will update the program counter value on the target. On success, a ProgramCounterSetOnTarget event is
* emitted.