refactor(naming)!: Breaking interface to follow standard naming convention.

* Namespace `libdbc` -> `Libdbc`
* Message method `parseMessage` -> `parse_message`
* Exception class names `exception` -> `Exception`, `validity_error` -> `ValidityError`
* Signal method names `parseSignals` -> `parse_signals`, `appendSignal` -> `append_signal`, -> `getSignals` -> `get_signals`, `addValueDescription` -> `add_value_description`
* Signal class name change `SignalValueDescriptions` -> `ValueDescription`
* Utils name space `utils` -> `Utils`

Using naming scheme of CamelCase for classes, structs, and namespaces. Snake case for everything else

Author: LinuxDevon

include/libdbc/dbc.hpp

@@ -8,7 +8,7 @@
 
 #include <regex>
 
-namespace libdbc {
+namespace Libdbc {
 
 class Parser {
 public:
@@ -27,14 +27,14 @@ class DbcParser : public Parser {
 
 	std::string get_version() const;
 	std::vector<std::string> get_nodes() const;
-	std::vector<libdbc::Message> get_messages() const;
+	std::vector<Libdbc::Message> get_messages() const;
 
-	Message::ParseSignalsStatus parseMessage(uint32_t message_id, const std::vector<uint8_t>& data, std::vector<double>& out_values);
+	Message::ParseSignalsStatus parse_message(uint32_t message_id, const std::vector<uint8_t>& data, std::vector<double>& out_values);
 
 private:
 	std::string version;
 	std::vector<std::string> nodes;
-	std::vector<libdbc::Message> messages;
+	std::vector<Libdbc::Message> messages;
 
 	std::regex version_re;
 	std::regex bit_timing_re;

include/libdbc/exceptions/error.hpp

@@ -3,16 +3,16 @@
 
 #include <exception>
 
-namespace libdbc {
+namespace Libdbc {
 
-class exception : public std::exception {
+class Exception : public std::exception {
 public:
 	const char* what() const throw() override {
 		return "libdbc exception occurred";
 	}
 };
 
-class validity_error : public exception {
+class ValidityError : public Exception {
 public:
 	const char* what() const throw() override {
 		return "Invalid DBC file";

include/libdbc/message.hpp

@@ -7,7 +7,7 @@
 #include <string>
 #include <vector>
 
-namespace libdbc {
+namespace Libdbc {
 struct Message {
 	Message() = delete;
 	virtual ~Message() = default;
@@ -21,14 +21,14 @@ struct Message {
 		ErrorInvalidConversion,
 	};
 
-	ParseSignalsStatus parseSignals(const std::vector<uint8_t>& data, std::vector<double>& values) const;
+	ParseSignalsStatus parse_signals(const std::vector<uint8_t>& data, std::vector<double>& values) const;
 
-	void appendSignal(const Signal& signal);
-	std::vector<Signal> getSignals() const;
+	void append_signal(const Signal& signal);
+	std::vector<Signal> get_signals() const;
 	uint32_t id() const;
 	uint8_t size() const;
 	const std::string& name() const;
-	void addValueDescription(const std::string& signal_name, const std::vector<Signal::SignalValueDescriptions>&);
+	void add_value_description(const std::string& signal_name, const std::vector<Signal::ValueDescription>&);
 
 	virtual bool operator==(const Message& rhs) const;
 

include/libdbc/signal.hpp

@@ -7,9 +7,9 @@
 #include <string>
 #include <vector>
 
-namespace libdbc {
+namespace Libdbc {
 struct Signal {
-	struct SignalValueDescriptions {
+	struct ValueDescription {
 		uint32_t value;
 		std::string description;
 	};
@@ -26,7 +26,7 @@ struct Signal {
 	double max;
 	std::string unit;
 	std::vector<std::string> receivers;
-	std::vector<SignalValueDescriptions> svDescriptions;
+	std::vector<ValueDescription> value_descriptions;
 
 	Signal() = delete;
 	virtual ~Signal() = default;

include/libdbc/utils/utils.hpp

@@ -9,7 +9,7 @@
 #include <sstream>
 #include <string>
 
-namespace utils {
+namespace Utils {
 
 class StreamHandler {
 public:

src/dbc.cpp

@@ -6,7 +6,7 @@
 #include <regex>
 #include <vector>
 
-namespace libdbc {
+namespace Libdbc {
 
 const auto floatPattern = "(-?\\d+\\.?(\\d+)?)"; // Can be negative
 
@@ -45,12 +45,10 @@ constexpr unsigned MESSAGE_NAME_GROUP = 3;
 constexpr unsigned MESSAGE_SIZE_GROUP = 4;
 constexpr unsigned MESSAGE_NODE_GROUP = 5;
 
-enum VALToken { Identifier = 0, CANId, SignalName, Value, Description };
-
-struct VALObject {
+struct Value {
 	uint32_t can_id;
 	std::string signal_name;
-	std::vector<Signal::SignalValueDescriptions> vd;
+	std::vector<Signal::ValueDescription> value_descriptions;
 };
 
 DbcParser::DbcParser()
@@ -79,7 +77,7 @@ void DbcParser::parse_file(const std::string& file) {
 	parse_dbc_nodes(stream);
 
 	while (!stream.eof()) {
-		utils::StreamHandler::get_next_non_blank_line(stream, line);
+		Utils::StreamHandler::get_next_non_blank_line(stream, line);
 		lines.push_back(line);
 	}
 
@@ -94,14 +92,14 @@ std::vector<std::string> DbcParser::get_nodes() const {
 	return nodes;
 }
 
-std::vector<libdbc::Message> DbcParser::get_messages() const {
+std::vector<Libdbc::Message> DbcParser::get_messages() const {
 	return messages;
 }
 
-Message::ParseSignalsStatus DbcParser::parseMessage(const uint32_t message_id, const std::vector<uint8_t>& data, std::vector<double>& out_values) {
+Message::ParseSignalsStatus DbcParser::parse_message(const uint32_t message_id, const std::vector<uint8_t>& data, std::vector<double>& out_values) {
 	for (const auto& message : messages) {
 		if (message.id() == message_id) {
-			return message.parseSignals(data, out_values);
+			return message.parse_signals(data, out_values);
 		}
 	}
 	return Message::ParseSignalsStatus::ErrorUnknownID;
@@ -111,43 +109,43 @@ void DbcParser::parse_dbc_header(std::istream& file_stream) {
 	std::string line;
 	std::smatch match;
 
-	utils::StreamHandler::get_line(file_stream, line);
+	Utils::StreamHandler::get_line(file_stream, line);
 
 	if (!std::regex_search(line, match, version_re)) {
-		throw validity_error();
+		throw ValidityError();
 	}
 
 	version = match.str(2);
 
-	utils::StreamHandler::get_next_non_blank_line(file_stream, line);
-	utils::StreamHandler::skip_to_next_blank_line(file_stream, line);
-	utils::StreamHandler::get_next_non_blank_line(file_stream, line);
+	Utils::StreamHandler::get_next_non_blank_line(file_stream, line);
+	Utils::StreamHandler::skip_to_next_blank_line(file_stream, line);
+	Utils::StreamHandler::get_next_non_blank_line(file_stream, line);
 
 	if (!std::regex_search(line, match, bit_timing_re)) {
-		throw validity_error();
+		throw ValidityError();
 	}
 }
 
 void DbcParser::parse_dbc_nodes(std::istream& file_stream) {
 	std::string line;
 	std::smatch match;
 
-	utils::StreamHandler::get_next_non_blank_line(file_stream, line);
+	Utils::StreamHandler::get_next_non_blank_line(file_stream, line);
 
 	if (!std::regex_search(line, match, node_re)) {
-		throw validity_error();
+		throw ValidityError();
 	}
 
 	if (match.length() > 2) {
 		std::string node = match.str(2);
-		utils::String::split(node, nodes);
+		Utils::String::split(node, nodes);
 	}
 }
 
 void DbcParser::parse_dbc_messages(const std::vector<std::string>& lines) {
 	std::smatch match;
 
-	std::vector<VALObject> signal_value;
+	std::vector<Value> signal_value;
 
 	for (const auto& line : lines) {
 		if (std::regex_search(line, match, message_re)) {
@@ -170,18 +168,18 @@ void DbcParser::parse_dbc_messages(const std::vector<std::string>& lines) {
 			bool is_bigendian = (std::stoul(match.str(SIGNAL_ENDIAN_GROUP)) == 0);
 			bool is_signed = (match.str(SIGNAL_SIGNED_GROUP) == "-");
 
-			double factor = utils::String::convert_to_double(match.str(SIGNAL_FACTOR_GROUP));
-			double offset = utils::String::convert_to_double(match.str(SIGNAL_OFFSET_GROUP));
-			double min = utils::String::convert_to_double(match.str(SIGNAL_MIN_GROUP));
-			double max = utils::String::convert_to_double(match.str(SIGNAL_MAX_GROUP));
+			double factor = Utils::String::convert_to_double(match.str(SIGNAL_FACTOR_GROUP));
+			double offset = Utils::String::convert_to_double(match.str(SIGNAL_OFFSET_GROUP));
+			double min = Utils::String::convert_to_double(match.str(SIGNAL_MIN_GROUP));
+			double max = Utils::String::convert_to_double(match.str(SIGNAL_MAX_GROUP));
 
 			std::string unit = match.str(SIGNAL_UNIT_GROUP);
 
 			std::vector<std::string> receivers;
-			utils::String::split(match.str(SIGNAL_RECIEVER_GROUP), receivers, ',');
+			Utils::String::split(match.str(SIGNAL_RECIEVER_GROUP), receivers, ',');
 
 			Signal sig(name, is_multiplexed, start_bit, size, is_bigendian, is_signed, factor, offset, min, max, unit, receivers);
-			messages.back().appendSignal(sig);
+			messages.back().append_signal(sig);
 			continue;
 		}
 
@@ -196,27 +194,27 @@ void DbcParser::parse_dbc_messages(const std::vector<std::string>& lines) {
 			std::sregex_iterator desc_iter(rest_of_descriptions.begin(), rest_of_descriptions.end(), description_re);
 			std::sregex_iterator desc_end = std::sregex_iterator();
 
-			std::vector<Signal::SignalValueDescriptions> values{};
+			std::vector<Signal::ValueDescription> values{};
 			for (std::sregex_iterator i = desc_iter; i != desc_end; ++i) {
 				std::smatch desc_match = *desc_iter;
 				uint32_t number = static_cast<uint32_t>(std::stoul(desc_match.str(1)));
 				std::string text = desc_match.str(2);
 
-				values.push_back(Signal::SignalValueDescriptions{number, text});
+				values.push_back(Signal::ValueDescription{number, text});
 				++desc_iter;
 			}
 
-			VALObject obj{message_id, signal_name, values};
+			Value val{message_id, signal_name, values};
 
-			signal_value.push_back(obj);
+			signal_value.push_back(val);
 			continue;
 		}
 	}
 
 	for (const auto& signal : signal_value) {
 		for (auto& msg : messages) {
 			if (msg.id() == signal.can_id) {
-				msg.addValueDescription(signal.signal_name, signal.vd);
+				msg.add_value_description(signal.signal_name, signal.value_descriptions);
 				break;
 			}
 		}

src/message.cpp

@@ -1,7 +1,7 @@
 #include <cstdint>
 #include <libdbc/message.hpp>
 
-namespace libdbc {
+namespace Libdbc {
 
 constexpr unsigned ONE_BYTE = 8;
 constexpr unsigned TWO_BYTES = 16;
@@ -21,7 +21,7 @@ bool Message::operator==(const Message& rhs) const {
 	return (m_id == rhs.id()) && (m_name == rhs.m_name) && (m_size == rhs.m_size) && (m_node == rhs.m_node);
 }
 
-Message::ParseSignalsStatus Message::parseSignals(const std::vector<uint8_t>& data, std::vector<double>& values) const {
+Message::ParseSignalsStatus Message::parse_signals(const std::vector<uint8_t>& data, std::vector<double>& values) const {
 	auto size = data.size();
 	if (size > ONE_BYTE) {
 		return ParseSignalsStatus::ErrorMessageToLong; // not supported yet
@@ -83,11 +83,11 @@ Message::ParseSignalsStatus Message::parseSignals(const std::vector<uint8_t>& da
 	return ParseSignalsStatus::Success;
 }
 
-void Message::appendSignal(const Signal& signal) {
+void Message::append_signal(const Signal& signal) {
 	m_signals.push_back(signal);
 }
 
-std::vector<Signal> Message::getSignals() const {
+std::vector<Signal> Message::get_signals() const {
 	return m_signals;
 }
 
@@ -103,10 +103,10 @@ const std::string& Message::name() const {
 	return m_name;
 }
 
-void Message::addValueDescription(const std::string& signal_name, const std::vector<Signal::SignalValueDescriptions>& value_descriptor) {
+void Message::add_value_description(const std::string& signal_name, const std::vector<Signal::ValueDescription>& value_descriptor) {
 	for (auto& signal : m_signals) {
 		if (signal.name == signal_name) {
-			signal.svDescriptions = value_descriptor;
+			signal.value_descriptions = value_descriptor;
 			return;
 		}
 	}

src/signal.cpp

@@ -1,6 +1,6 @@
 #include <libdbc/signal.hpp>
 
-namespace libdbc {
+namespace Libdbc {
 Signal::Signal(std::string name,
 			   bool is_multiplexed,
 			   uint32_t start_bit,

src/utils.cpp

@@ -5,7 +5,7 @@
 
 #include <regex>
 
-namespace utils {
+namespace Utils {
 
 std::istream& StreamHandler::get_line(std::istream& stream, std::string& line) {
 	std::string newline;
@@ -32,7 +32,7 @@ std::istream& StreamHandler::get_next_non_blank_line(std::istream& stream, std::
 	std::smatch match;
 
 	while (is_blank) {
-		utils::StreamHandler::get_line(stream, line);
+		Utils::StreamHandler::get_line(stream, line);
 
 		std::regex_search(line, match, whitespace_re);
 
@@ -53,7 +53,7 @@ std::istream& StreamHandler::skip_to_next_blank_line(std::istream& stream, std::
 	std::smatch match;
 
 	while (!line_is_empty) {
-		utils::StreamHandler::get_line(stream, line);
+		Utils::StreamHandler::get_line(stream, line);
 
 		std::regex_search(line, match, whitespace_re);
 
@@ -74,9 +74,8 @@ std::string String::trim(const std::string& line) {
 
 double String::convert_to_double(const std::string& value, double default_value) {
 	double converted_value = default_value;
-	fast_float::from_chars(value.data(),
-						   value.data() + value.size(),
-						   converted_value); // NOLINT -- Trying to iterators on the value causes the test to infinitly hang on windows builds
+	// NOLINTNEXTLINE -- Trying to iterators on the value causes the test to infinitly hang on windows builds
+	fast_float::from_chars(value.data(), value.data() + value.size(), converted_value);
 	return converted_value;
 }