Improved naming consistency of aliases

This commit is contained in:
Nav
2022-10-01 21:01:37 +01:00
parent 2c6fd25ae4
commit 065a389dfe
56 changed files with 96 additions and 93 deletions

View File

@@ -32,7 +32,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
}
std::unique_ptr<Gdb::CommandPackets::CommandPacket> AvrGdbRsp::resolveCommandPacket(
const RawPacketType& rawPacket
const RawPacket& rawPacket
) {
using AvrGdb::CommandPackets::ReadMemory;
using AvrGdb::CommandPackets::WriteMemory;

View File

@@ -29,7 +29,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
}
std::unique_ptr<Gdb::CommandPackets::CommandPacket> resolveCommandPacket(
const RawPacketType& rawPacket
const RawPacket& rawPacket
) override;
std::set<std::pair<Feature, std::optional<std::string>>> getSupportedFeatures() override ;

View File

@@ -15,7 +15,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
using namespace Bloom::Exceptions;
FlashDone::FlashDone(const RawPacketType& rawPacket)
FlashDone::FlashDone(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{}

View File

@@ -16,7 +16,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
class FlashDone: public Gdb::CommandPackets::CommandPacket
{
public:
explicit FlashDone(const RawPacketType& rawPacket);
explicit FlashDone(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -15,7 +15,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
using namespace Bloom::Exceptions;
FlashErase::FlashErase(const RawPacketType& rawPacket)
FlashErase::FlashErase(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
const auto packetString = QString::fromLocal8Bit(

View File

@@ -20,7 +20,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
std::uint32_t startAddress = 0;
std::uint32_t bytes = 0;
explicit FlashErase(const RawPacketType& rawPacket);
explicit FlashErase(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -17,7 +17,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
using namespace Bloom::Exceptions;
FlashWrite::FlashWrite(const RawPacketType& rawPacket)
FlashWrite::FlashWrite(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
if (this->data.size() < 15) {

View File

@@ -20,7 +20,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
std::uint32_t startAddress = 0;
Targets::TargetMemoryBuffer buffer;
explicit FlashWrite(const RawPacketType& rawPacket);
explicit FlashWrite(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -15,7 +15,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
using Exceptions::Exception;
ReadMemory::ReadMemory(const RawPacketType& rawPacket, const TargetDescriptor& gdbTargetDescriptor)
ReadMemory::ReadMemory(const RawPacket& rawPacket, const TargetDescriptor& gdbTargetDescriptor)
: CommandPacket(rawPacket)
{
if (this->data.size() < 4) {

View File

@@ -32,7 +32,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
*/
Targets::TargetMemorySize bytes = 0;
explicit ReadMemory(const RawPacketType& rawPacket, const Gdb::TargetDescriptor& gdbTargetDescriptor);
explicit ReadMemory(const RawPacket& rawPacket, const Gdb::TargetDescriptor& gdbTargetDescriptor);
void handle(
DebugSession& debugSession,

View File

@@ -12,7 +12,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
using Exceptions::Exception;
ReadMemoryMap::ReadMemoryMap(const RawPacketType& rawPacket)
ReadMemoryMap::ReadMemoryMap(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
if (this->data.size() < 26) {

View File

@@ -23,7 +23,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
*/
std::uint32_t length = 0;
explicit ReadMemoryMap(const RawPacketType& rawPacket);
explicit ReadMemoryMap(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -15,7 +15,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
using namespace Bloom::Exceptions;
WriteMemory::WriteMemory(const RawPacketType& rawPacket, const TargetDescriptor& gdbTargetDescriptor)
WriteMemory::WriteMemory(const RawPacket& rawPacket, const TargetDescriptor& gdbTargetDescriptor)
: CommandPacket(rawPacket)
{
if (this->data.size() < 4) {

View File

@@ -32,7 +32,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb::CommandPackets
*/
Targets::TargetMemoryBuffer buffer;
explicit WriteMemory(const RawPacketType& rawPacket, const Gdb::TargetDescriptor& gdbTargetDescriptor);
explicit WriteMemory(const RawPacket& rawPacket, const Gdb::TargetDescriptor& gdbTargetDescriptor);
void handle(
DebugSession& debugSession,

View File

@@ -24,13 +24,13 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
this->loadRegisterMappings();
}
std::optional<GdbRegisterNumberType> TargetDescriptor::getRegisterNumberFromTargetRegisterDescriptor(
std::optional<GdbRegisterNumber> TargetDescriptor::getRegisterNumberFromTargetRegisterDescriptor(
const Targets::TargetRegisterDescriptor& registerDescriptor
) const {
return this->targetRegisterDescriptorsByGdbNumber.valueAt(registerDescriptor);
}
const RegisterDescriptor& TargetDescriptor::getRegisterDescriptorFromNumber(GdbRegisterNumberType number) const {
const RegisterDescriptor& TargetDescriptor::getRegisterDescriptorFromNumber(GdbRegisterNumber number) const {
if (this->registerDescriptorsByGdbNumber.contains(number)) {
return this->registerDescriptorsByGdbNumber.at(number);
}
@@ -40,7 +40,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
}
const TargetRegisterDescriptor& TargetDescriptor::getTargetRegisterDescriptorFromNumber(
GdbRegisterNumberType number
GdbRegisterNumber number
) const {
if (this->targetRegisterDescriptorsByGdbNumber.contains(number)) {
return this->targetRegisterDescriptorsByGdbNumber.at(number);
@@ -50,7 +50,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
+ ") not mapped to any target register descriptor.");
}
const std::vector<GdbRegisterNumberType>& TargetDescriptor::getRegisterNumbers() const {
const std::vector<GdbRegisterNumber>& TargetDescriptor::getRegisterNumbers() const {
return this->registerNumbers;
}
@@ -98,7 +98,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
);
// General purpose registers
GdbRegisterNumberType regNumber = 0;
GdbRegisterNumber regNumber = 0;
for (const auto& descriptor : gpRegisterDescriptors) {
this->registerDescriptorsByGdbNumber.insert(std::pair(
regNumber,

View File

@@ -9,8 +9,8 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
class TargetDescriptor: public DebugServer::Gdb::TargetDescriptor
{
public:
BiMap<GdbRegisterNumberType, RegisterDescriptor> registerDescriptorsByGdbNumber = {};
BiMap<GdbRegisterNumberType, Targets::TargetRegisterDescriptor> targetRegisterDescriptorsByGdbNumber = {};
BiMap<GdbRegisterNumber, RegisterDescriptor> registerDescriptorsByGdbNumber = {};
BiMap<GdbRegisterNumber, Targets::TargetRegisterDescriptor> targetRegisterDescriptorsByGdbNumber = {};
explicit TargetDescriptor(const Targets::TargetDescriptor& targetDescriptor);
@@ -21,7 +21,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
* @param registerDescriptor
* @return
*/
std::optional<GdbRegisterNumberType> getRegisterNumberFromTargetRegisterDescriptor(
std::optional<GdbRegisterNumber> getRegisterNumberFromTargetRegisterDescriptor(
const Targets::TargetRegisterDescriptor& registerDescriptor
) const override;
@@ -31,7 +31,7 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
* @param number
* @return
*/
const RegisterDescriptor& getRegisterDescriptorFromNumber(GdbRegisterNumberType number) const override;
const RegisterDescriptor& getRegisterDescriptorFromNumber(GdbRegisterNumber number) const override;
/**
* Should retrieve the mapped target register descriptor for a given GDB register number.
@@ -40,13 +40,13 @@ namespace Bloom::DebugServer::Gdb::AvrGdb
* @return
*/
const Targets::TargetRegisterDescriptor& getTargetRegisterDescriptorFromNumber(
GdbRegisterNumberType number
GdbRegisterNumber number
) const override;
const std::vector<GdbRegisterNumberType>& getRegisterNumbers() const override;
const std::vector<GdbRegisterNumber>& getRegisterNumbers() const override;
private:
std::vector<GdbRegisterNumberType> registerNumbers = std::vector<GdbRegisterNumberType>(35);
std::vector<GdbRegisterNumber> registerNumbers = std::vector<GdbRegisterNumber>(35);
/**
* For AVR targets, avr-gdb defines 35 registers in total:

View File

@@ -36,7 +36,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
class CommandPacket: public Packet
{
public:
explicit CommandPacket(const RawPacketType& rawPacket): Packet(rawPacket) {}
explicit CommandPacket(const RawPacket& rawPacket): Packet(rawPacket) {}
/**
* Should handle the command for the current active debug session.

View File

@@ -12,7 +12,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
using ResponsePackets::ErrorResponsePacket;
using Exceptions::Exception;
ContinueExecution::ContinueExecution(const RawPacketType& rawPacket)
ContinueExecution::ContinueExecution(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
if (this->data.size() > 1) {

View File

@@ -26,7 +26,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
*/
std::optional<Targets::TargetProgramCounter> fromProgramCounter;
explicit ContinueExecution(const RawPacketType& rawPacket);
explicit ContinueExecution(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -16,7 +16,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
using Exceptions::Exception;
Detach::Detach(const RawPacketType& rawPacket)
Detach::Detach(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{}

View File

@@ -7,7 +7,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
class Detach: public CommandPacket
{
public:
explicit Detach(const RawPacketType& rawPacket);
explicit Detach(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -15,7 +15,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
class InterruptExecution: public CommandPacket
{
public:
explicit InterruptExecution(const RawPacketType& rawPacket): CommandPacket(rawPacket) {}
explicit InterruptExecution(const RawPacket& rawPacket): CommandPacket(rawPacket) {}
void handle(
DebugSession& debugSession,

View File

@@ -10,7 +10,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
using ResponsePackets::EmptyResponsePacket;
Monitor::Monitor(const RawPacketType& rawPacket)
Monitor::Monitor(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
if (this->data.size() > 6) {

View File

@@ -17,7 +17,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
*/
std::string command;
explicit Monitor(const RawPacketType& rawPacket);
explicit Monitor(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -19,7 +19,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
using Exceptions::Exception;
ReadRegisters::ReadRegisters(const RawPacketType& rawPacket)
ReadRegisters::ReadRegisters(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
if (this->data.size() >= 2 && this->data.front() == 'p') {

View File

@@ -23,9 +23,9 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
* If the register number is not supplied (as is the case with "g" packets), the server is expected to respond
* with values for all registers.
*/
std::optional<GdbRegisterNumberType> registerNumber;
std::optional<GdbRegisterNumber> registerNumber;
explicit ReadRegisters(const RawPacketType& rawPacket);
explicit ReadRegisters(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -21,7 +21,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
using Exceptions::Exception;
RemoveBreakpoint::RemoveBreakpoint(const RawPacketType& rawPacket)
RemoveBreakpoint::RemoveBreakpoint(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
if (this->data.size() < 6) {

View File

@@ -28,7 +28,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
*/
Targets::TargetMemoryAddress address = 0;
explicit RemoveBreakpoint(const RawPacketType& rawPacket);
explicit RemoveBreakpoint(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -21,7 +21,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
using Exceptions::Exception;
SetBreakpoint::SetBreakpoint(const RawPacketType& rawPacket)
SetBreakpoint::SetBreakpoint(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
if (this->data.size() < 6) {

View File

@@ -28,7 +28,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
*/
Targets::TargetMemoryAddress address = 0;
explicit SetBreakpoint(const RawPacketType& rawPacket);
explicit SetBreakpoint(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -13,7 +13,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
using Exceptions::Exception;
StepExecution::StepExecution(const RawPacketType& rawPacket)
StepExecution::StepExecution(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
if (this->data.size() > 1) {

View File

@@ -21,7 +21,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
*/
std::optional<Targets::TargetProgramCounter> fromProgramCounter;
explicit StepExecution(const RawPacketType& rawPacket);
explicit StepExecution(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -21,7 +21,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
using Bloom::Exceptions::Exception;
using Gdb::Exceptions::ClientNotSupported;
SupportedFeaturesQuery::SupportedFeaturesQuery(const RawPacketType& rawPacket)
SupportedFeaturesQuery::SupportedFeaturesQuery(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
/*

View File

@@ -22,7 +22,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
class SupportedFeaturesQuery: public CommandPacket
{
public:
explicit SupportedFeaturesQuery(const RawPacketType& rawPacket);
explicit SupportedFeaturesQuery(const RawPacket& rawPacket);
[[nodiscard]] bool isFeatureSupported(const Feature& feature) const {
return this->supportedFeatures.find(feature) != this->supportedFeatures.end();

View File

@@ -22,7 +22,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
using Exceptions::Exception;
WriteRegister::WriteRegister(const RawPacketType& rawPacket)
WriteRegister::WriteRegister(const RawPacket& rawPacket)
: CommandPacket(rawPacket)
{
// The P packet updates a single register

View File

@@ -17,7 +17,7 @@ namespace Bloom::DebugServer::Gdb::CommandPackets
int registerNumber = 0;
std::vector<unsigned char> registerValue;
explicit WriteRegister(const RawPacketType& rawPacket);
explicit WriteRegister(const RawPacket& rawPacket);
void handle(
DebugSession& debugSession,

View File

@@ -51,8 +51,8 @@ namespace Bloom::DebugServer::Gdb
return std::string(ipAddress.data());
}
std::vector<RawPacketType> Connection::readRawPackets() {
std::vector<RawPacketType> output;
std::vector<RawPacket> Connection::readRawPackets() {
std::vector<RawPacket> output;
const auto bytes = this->read();
@@ -71,7 +71,7 @@ namespace Bloom::DebugServer::Gdb
} else if (byte == '$') {
// Beginning of packet
RawPacketType rawPacket;
RawPacket rawPacket;
rawPacket.push_back('$');
auto packetIndex = byteIndex;

View File

@@ -57,7 +57,7 @@ namespace Bloom::DebugServer::Gdb
*
* @return
*/
std::vector<RawPacketType> readRawPackets();
std::vector<RawPacket> readRawPackets();
/**
* Sends a response packet to the client.

View File

@@ -254,7 +254,7 @@ namespace Bloom::DebugServer::Gdb
return this->resolveCommandPacket(rawPackets.back());
}
std::unique_ptr<CommandPacket> GdbRspDebugServer::resolveCommandPacket(const RawPacketType& rawPacket) {
std::unique_ptr<CommandPacket> GdbRspDebugServer::resolveCommandPacket(const RawPacket& rawPacket) {
if (rawPacket.size() == 5 && rawPacket[1] == 0x03) {
// Interrupt request
return std::make_unique<CommandPackets::InterruptExecution>(rawPacket);

View File

@@ -161,7 +161,7 @@ namespace Bloom::DebugServer::Gdb
* @param rawPacket
* @return
*/
virtual std::unique_ptr<CommandPackets::CommandPacket> resolveCommandPacket(const RawPacketType& rawPacket);
virtual std::unique_ptr<CommandPackets::CommandPacket> resolveCommandPacket(const RawPacket& rawPacket);
/**
* Should return a set of GDB features supported by the GDB server. Each supported feature may come with an

View File

@@ -9,7 +9,7 @@
namespace Bloom::DebugServer::Gdb
{
using RawPacketType = std::vector<unsigned char>;
using RawPacket = std::vector<unsigned char>;
/**
* The Packet class implements the data structure for GDB RSP packets.
@@ -19,7 +19,7 @@ namespace Bloom::DebugServer::Gdb
class Packet
{
public:
explicit Packet(const RawPacketType& rawPacket) {
explicit Packet(const RawPacket& rawPacket) {
this->init(rawPacket);
}
@@ -45,7 +45,7 @@ namespace Bloom::DebugServer::Gdb
*
* @return
*/
[[nodiscard]] RawPacketType toRawPacket() const {
[[nodiscard]] RawPacket toRawPacket() const {
std::vector<unsigned char> packet = {'$'};
auto data = this->getData();
@@ -139,7 +139,7 @@ namespace Bloom::DebugServer::Gdb
protected:
std::vector<unsigned char> data;
void init(const RawPacketType& rawPacket) {
void init(const RawPacket& rawPacket) {
this->data.insert(
this->data.begin(),
rawPacket.begin() + 1,

View File

@@ -51,7 +51,7 @@ public:
*/
std::uint32_t address = 0;
explicit SetBreakpoint(const RawPacketType& rawPacket);
explicit SetBreakpoint(const RawPacket& rawPacket);
void handle(DebugSession& debugSession, TargetControllerConsole& targetControllerConsole) override;
};

View File

@@ -5,7 +5,7 @@
namespace Bloom::DebugServer::Gdb
{
using GdbRegisterNumberType = int;
using GdbRegisterNumber = int;
/*
* GDB defines a set of registers for each target architecture.
@@ -14,12 +14,15 @@ namespace Bloom::DebugServer::Gdb
*/
struct RegisterDescriptor
{
GdbRegisterNumberType number;
GdbRegisterNumber number;
std::uint16_t size;
std::string name;
RegisterDescriptor(GdbRegisterNumberType number, std::uint16_t size, const std::string& name)
: number(number), size(size), name(name) {};
RegisterDescriptor(GdbRegisterNumber number, std::uint16_t size, const std::string& name)
: number(number)
, size(size)
, name(name)
{};
bool operator == (const RegisterDescriptor& other) const {
return this->number == other.number;

View File

@@ -59,7 +59,7 @@ namespace Bloom::DebugServer::Gdb
* @param registerDescriptor
* @return
*/
virtual std::optional<GdbRegisterNumberType> getRegisterNumberFromTargetRegisterDescriptor(
virtual std::optional<GdbRegisterNumber> getRegisterNumberFromTargetRegisterDescriptor(
const Targets::TargetRegisterDescriptor& registerDescriptor
) const = 0;
@@ -69,7 +69,7 @@ namespace Bloom::DebugServer::Gdb
* @param number
* @return
*/
virtual const RegisterDescriptor& getRegisterDescriptorFromNumber(GdbRegisterNumberType number) const = 0;
virtual const RegisterDescriptor& getRegisterDescriptorFromNumber(GdbRegisterNumber number) const = 0;
/**
* Should retrieve the mapped target register descriptor for a given GDB register number.
@@ -78,7 +78,7 @@ namespace Bloom::DebugServer::Gdb
* @return
*/
virtual const Targets::TargetRegisterDescriptor& getTargetRegisterDescriptorFromNumber(
GdbRegisterNumberType number
GdbRegisterNumber number
) const = 0;
/**
@@ -86,7 +86,7 @@ namespace Bloom::DebugServer::Gdb
*
* @return
*/
virtual const std::vector<GdbRegisterNumberType>& getRegisterNumbers() const = 0;
virtual const std::vector<GdbRegisterNumber>& getRegisterNumbers() const = 0;
private:
BiMap<Targets::TargetMemoryType, std::uint32_t> memoryOffsetsByType;