hyperion.ng/include/utils/FileUtils.h

#pragma once

// qt includes
#include <QFile>
#include <QString>
#include <QByteArray>

// util includes
#include "Logger.h"

namespace FileUtils {

QString getBaseName( QString sourceFile);
QString getDirName( QString sourceFile);

	///
	/// @brief check if the file exists
	/// @param[in]   path     The file path to check
	/// @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
	///
	bool fileExists(const QString& path, Logger* log, bool ignError=false);

	///
	/// @brief read a file given by path.
	/// @param[in]   path     The file path to read
	/// @param[out]  data     The read data o success
	/// @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
	///
	bool readFile(const QString& path, QString& data, Logger* log, bool ignError=false);

	///
	/// write a file given by path.
	/// @param[in]   path     The file path to read
	/// @param[in]   data     The data to write
	/// @param[in]   log      The logger of the caller to print errors
	/// @return               true on success else false
	///
	bool writeFile(const QString& path, const QByteArray& data, Logger* log);

	///
	/// @brief delete a file by given path
	/// @param[in]   path     The file path to delete
	/// @param[in]   log      The logger of the caller to print errors
	/// @return               true on success else false
	///
	bool removeFile(const QString& path, Logger* log);

	///
	/// @brief Convert a path that may contain special placeholders
	/// @param[in]   path     The path to convert
	///
	QString convertPath(const QString path);

	///
	/// @brief resolve the file error and print a message
	/// @param[in]  file     The file which caused the error
	/// @param[in]  log      The logger of the caller
	///
	void resolveFileError(const QFile& file, Logger* log);
};