QGCFileHelper.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QByteArray>
#include <QtCore/QCryptographicHash>
#include <QtCore/QString>
#include <QtCore/QTemporaryFile>
#include <QtCore/QUrl>
 
#include <memory>
 
namespace QGCFileHelper {
 
QByteArray readFile(const QString &filePath, QString *errorString = nullptr,
                    qint64 maxBytes = 0);
 
// ============================================================================
// Buffer Configuration
// ============================================================================
 
constexpr size_t kBufferSizeMin = 16384;     // 16KB
 
constexpr size_t kBufferSizeMax = 131072;    // 128KB
 
constexpr size_t kBufferSizeDefault = 65536; // 64KB
 
size_t optimalBufferSize(const QString &path = QString());
 
// ============================================================================
// Path Utilities
// ============================================================================
 
bool exists(const QString &path);
 
QString joinPath(const QString &dir, const QString &name);
 
bool ensureDirectoryExists(const QString &path);
 
bool ensureParentExists(const QString &filePath);
 
bool copyDirectoryRecursively(const QString &sourcePath, const QString &destPath);
 
bool moveFileOrCopy(const QString &sourcePath, const QString &destPath);
 
// ============================================================================
// Safe File Operations
// ============================================================================
 
bool atomicWrite(const QString &filePath, const QByteArray &data);
 
// ============================================================================
// Disk Space Utilities
// ============================================================================
 
bool hasSufficientDiskSpace(const QString &path, qint64 requiredBytes, double margin = 1.1);
 
qint64 availableDiskSpace(const QString &path);
 
// ============================================================================
// URL/Path Utilities
// ============================================================================
 
QString toLocalPath(const QString &urlOrPath);
 
QString toLocalPath(const QUrl &url);
 
bool isLocalPath(const QString &urlOrPath);
 
bool isQtResource(const QString &path);
 
// ============================================================================
// Checksum Utilities
// ============================================================================
 
constexpr QCryptographicHash::Algorithm kDefaultHashAlgorithm = QCryptographicHash::Sha256;
 
QString computeFileHash(const QString &filePath,
                        QCryptographicHash::Algorithm algorithm = kDefaultHashAlgorithm);
 
QString computeHash(const QByteArray &data,
                    QCryptographicHash::Algorithm algorithm = kDefaultHashAlgorithm);
 
bool verifyFileHash(const QString &filePath, const QString &expectedHash,
                    QCryptographicHash::Algorithm algorithm = kDefaultHashAlgorithm);
 
QString hashAlgorithmName(QCryptographicHash::Algorithm algorithm);
 
// ============================================================================
// Temporary File Utilities
// ============================================================================
 
std::unique_ptr<QTemporaryFile> createTempFile(const QByteArray &data,
                                                const QString &templateName = QString());
 
std::unique_ptr<QTemporaryFile> createTempCopy(const QString &sourcePath,
                                                const QString &templateName = QString());
 
QString tempDirectory();
 
QString uniqueTempPath(const QString &templateName = QString());
 
bool replaceFileFromTemp(QTemporaryFile *tempFile, const QString &targetPath,
                         const QString &backupPath = QString());
 
} // namespace QGCFileHelper