Refactored smartctl output parser for better API, support for different formats.

src/applib/smartctl_parser.h

@@ -0,0 +1,108 @@
+/******************************************************************************
+License: GNU General Public License v3.0 only
+Copyright:
+	(C) 2022 Alexander Shaduri <ashaduri@gmail.com>
+******************************************************************************/
+/// \file
+/// \author Alexander Shaduri
+/// \ingroup applib
+/// \weakgroup applib
+/// @{
+
+#ifndef SMARTCTL_PARSER_H
+#define SMARTCTL_PARSER_H
+
+#include <string>
+#include <vector>
+#include <memory>
+
+#include "ata_storage_property.h"
+#include "smartctl_output_type.h"
+
+
+
+/// Smartctl (S)ATA text output parser.
+/// Note: ALL parse_* functions (except parse_full() and parse_version())
+/// expect data in unix-newline format!
+class SmartctlParser {
+	protected:
+
+		// Defaulted but hidden
+		SmartctlParser() = default;
+
+
+	public:
+
+		// Deleted
+		SmartctlParser(const SmartctlParser& other) = default;
+
+		// Deleted
+		SmartctlParser(SmartctlParser&& other) = delete;
+
+		// Deleted
+		SmartctlParser& operator=(const SmartctlParser& other) = delete;
+
+		// Deleted
+		SmartctlParser& operator=(SmartctlParser&& other) = delete;
+
+		/// Virtual member requirement
+		virtual ~SmartctlParser() = default;
+
+
+		/// Create an instance of this class.
+		/// \return nullptr if no such class exists
+		static std::unique_ptr<SmartctlParser> create(SmartctlOutputParserType type);
+
+
+		/// Create an instance of this class.
+		/// \return nullptr if no such class exists
+		static std::unique_ptr<SmartctlParser> detect_and_parse(SmartctlOutputParserType type);
+
+
+		/// Parse full "smartctl -x" output.
+		/// Note: Once parsed, this function cannot be called again.
+		virtual bool parse_full(const std::string& full) = 0;
+
+
+		/// Detect smartctl output type (text, json).
+		/// Return
+		[[nodiscard]] std::optional<SmartctlOutputParserType> detect_output_type(const std::string& output) const;
+
+
+		/// Get "full" data, as passed to parse_full().
+		[[nodiscard]] std::string get_data_full() const;
+
+		/// Get parse error message. Call this only if parsing doesn't succeed,
+		/// to get a friendly error message.
+		[[nodiscard]] std::string get_error_msg() const;
+
+		/// Get parse result properties
+		[[nodiscard]] const std::vector<AtaStorageProperty>& get_properties() const;
+
+
+	protected:
+
+		/// Add a property into property list, look up and set its description
+		void add_property(AtaStorageProperty p);
+
+		/// Set "full" data ("smartctl -x" output), json or text.
+		void set_data_full(const std::string& s);
+
+		/// Set error message
+		void set_error_msg(const std::string& s);
+
+
+	private:
+
+		std::vector<AtaStorageProperty> properties_;  ///< Parsed data properties
+		std::string data_full_;  ///< full data, filled by parse_full()
+		std::string error_msg_;  ///< This will be filled with some displayable message on error
+
+};
+
+
+
+
+#endif
+
+/// @}