hyperion.ng/include/utils/JsonUtils.h

#pragma once

#include <utils/FileUtils.h>

#include <QJsonObject>
#include <QJsonDocument>
#include <QPair>
#include <QStringList>
#include <utils/Logger.h>

namespace JsonUtils {
	///
	/// @brief read a JSON file and get the parsed result on success
	/// @param[in]  path     The file path to read
	/// @param[out] obj      Returns the parsed QJsonObject
	/// @param[in]  log      The logger of the caller to print errors
	/// @param[in]  ignError Ignore errors during file read (no log output)
	/// @return              true on success else false
	///
	QPair<bool, QStringList> readFile(const QString& path, QJsonObject& obj, Logger* log, bool ignError=false);
	QPair<bool, QStringList> readFile(const QString& path, QJsonValue& obj, Logger* log, bool ignError=false);

	///
	/// @brief read a schema file and resolve $refs
	/// @param[in]  path     The file path to read
	/// @param[out] obj      Returns the parsed QJsonObject
	/// @param[in]  log      The logger of the caller to print errors
	/// @return              true on success else false
	///
	bool readSchema(const QString& path, QJsonObject& obj, Logger* log);

	///
	/// @brief parse a JSON QString and get a QJsonObject. Overloaded funtion
	/// @param[in]  path     The file path/name context used for log messages
	/// @param[in]  data     Data to parse
	/// @param[out] obj      Retuns the parsed QJsonObject
	/// @param[in]  log      The logger of the caller to print errors
	/// @return              true on success else false
	///
	QPair<bool, QStringList> parse(const QString& path, const QString& data, QJsonObject& obj, Logger* log);
	QPair<bool, QStringList> parse(const QString& path, const QString& data, QJsonValue& value, Logger* log);

	///
	/// @brief parse a JSON QString and get a QJsonArray. Overloaded function
	/// @param[in]  path     The file path/name context used for log messages
	/// @param[in]  data     Data to parse
	/// @param[out] arr      Retuns the parsed QJsonArray
	/// @param[in]  log      The logger of the caller to print errors
	/// @return              true on success else false
	//
	QPair<bool, QStringList> parse(const QString& path, const QString& data, QJsonArray& arr, Logger* log);

	///
	/// @brief parse a JSON QString and get a QJsonDocument
	/// @param[in]  path     The file path/name context used for log messages
	/// @param[in]  data     Data to parse
	/// @param[out] doc      Retuns the parsed QJsonDocument
	/// @param[in]  log      The logger of the caller to print errors
	/// @return              true on success else false
	///
	QPair<bool, QStringList> parse(const QString& path, const QString& data, QJsonDocument& doc, Logger* log);

	///
	/// @brief Validate JSON data against a schema
	/// @param[in]   file     The path/name of JSON file context used for log messages
	/// @param[in]   json     The JSON data
	/// @param[in]   schemaP  The schema path
	/// @param[in]   log      The logger of the caller to print errors
	/// @return               true on success else false, plus validation errors
	///
	QPair<bool, QStringList> validate(const QString& file, const QJsonValue& json, const QString& schemaPath, Logger* log);

	///
	/// @brief Validate JSON data against a schema
	/// @param[in]   file     The path/name of JSON file context used for log messages
	/// @param[in]   json     The JSON data
	/// @param[in]   schema   The schema object
	/// @param[in]   log      The logger of the caller to print errors
	/// @return               true on success else false, plus validation errors
	///
	QPair<bool, QStringList> validate(const QString& file, const QJsonValue& json, const QJsonObject& schema, Logger* log);

	///
	/// @brief Validate JSON data against a schema
	/// @param[in]      file     The path/name of JSON file context used for log messages
	/// @param[in/out]  json     The JSON data
	/// @param[in]      schema   The schema object
	/// @param[in]      log      The logger of the caller to print errors
	/// @return         true on success else false, plus correction messages
	///
	QPair<bool, QStringList> correct(const QString& file, QJsonValue& json, const QJsonObject& schema, Logger* log);

	///
	/// @brief Write JSON data to file
	/// @param[in]   filenameThe file path to write
	/// @param[in]   json    The JSON data to write
	/// @param[in]   log     The logger of the caller to print errors
	/// @return              true on success else false
	///
	bool write(const QString& filename, const QJsonObject& json, Logger* log);

	///
	/// @brief resolve schema $ref attribute
	/// @param[in]   schema  the schema to iterate
	/// @param[out]  obj     the resolved object
	/// @param[in]   log     The logger of the caller to print errors
	/// @return              true on success else false
	///
	bool resolveRefs(const QJsonObject& schema, QJsonObject& obj, Logger* log);


	///
	/// @brief Function to convert QJsonValue to QString using QJsonDocument
	///
	QString jsonValueToQString(const QJsonValue &value, QJsonDocument::JsonFormat format = QJsonDocument::Compact);

	///
	/// @brief Function to merge two QJsonObjects
	///
	QJsonObject mergeJsonObjects(const QJsonObject &obj1, const QJsonObject &obj2, bool overrideObj1 = false);
}