QGCCompression.h

Go to the documentation of this file.

#pragma once
 
#include "QGCCompressionTypes.h"
 
#include <QtCore/QByteArray>
#include <QtCore/QCryptographicHash>
#include <QtCore/QIODevice>
#include <QtCore/QJsonDocument>
#include <QtCore/QJsonParseError>
#include <QtCore/QString>
#include <QtCore/QStringList>
 
namespace QGCCompression {
 
// ============================================================================
// Error Handling
// ============================================================================
 
enum class Error {
    None,               
    FileNotFound,       
    PermissionDenied,   
    InvalidArchive,     
    UnsupportedFormat,  
    SizeLimitExceeded,  
    Cancelled,          
    FileNotInArchive,   
    IoError,            
    InternalError       
};
 
Error lastError();
 
QString lastErrorString();
 
QString errorName(Error error);
 
// ============================================================================
// Format Definitions
// ============================================================================
 
enum class Format {
    Auto,       
    ZIP,        
    SEVENZ,     
    GZIP,       
    XZ,         
    ZSTD,       
    BZIP2,      
    LZ4,        
    TAR,        
    TAR_GZ,     
    TAR_XZ,     
    TAR_ZSTD,   
    TAR_BZ2,    
    TAR_LZ4,    
};
 
// ============================================================================
// Format Detection
// ============================================================================
 
Format detectFormat(const QString &filePath, bool useContentFallback = true);
 
Format detectFormatFromFile(const QString &filePath);
 
Format detectFormatFromData(const QByteArray &data);
 
QString formatExtension(Format format);
 
QString formatName(Format format);
 
bool isArchiveFormat(Format format);
 
bool isCompressionFormat(Format format);
 
inline bool isCompressedFile(const QString &filePath) {
    return isCompressionFormat(detectFormat(filePath));
}
 
inline bool isArchiveFile(const QString &filePath) {
    return isArchiveFormat(detectFormat(filePath));
}
 
QString strippedPath(const QString &filePath);
 
QString detectedFormatName();
 
QString detectedFilterName();
 
// ============================================================================
// Single-File Decompression
// ============================================================================
 
bool decompressFile(const QString &inputPath, const QString &outputPath = QString(),
                    Format format = Format::Auto,
                    ProgressCallback progress = nullptr,
                    qint64 maxDecompressedBytes = 0);
 
QString decompressIfNeeded(const QString &filePath,
                           const QString &outputPath = QString(),
                           bool removeOriginal = false);
 
QByteArray decompressData(const QByteArray &data, Format format = Format::Auto,
                          qint64 maxDecompressedBytes = 0);
 
// ============================================================================
// Archive Extraction (Multiple Files)
// ============================================================================
 
bool extractArchive(const QString &archivePath, const QString &outputDirectoryPath,
                    Format format = Format::Auto,
                    ProgressCallback progress = nullptr,
                    qint64 maxDecompressedBytes = 0);
 
bool extractArchiveAtomic(const QString &archivePath, const QString &outputDirectoryPath,
                          Format format = Format::Auto,
                          ProgressCallback progress = nullptr,
                          qint64 maxDecompressedBytes = 0);
 
bool extractArchiveFiltered(const QString &archivePath, const QString &outputDirectoryPath,
                            EntryFilter filter,
                            ProgressCallback progress = nullptr,
                            qint64 maxDecompressedBytes = 0);
 
QStringList listArchive(const QString &archivePath, Format format = Format::Auto);
 
QList<ArchiveEntry> listArchiveDetailed(const QString &archivePath, Format format = Format::Auto);
 
ArchiveStats getArchiveStats(const QString &archivePath, Format format = Format::Auto);
 
bool validateArchive(const QString &archivePath, Format format = Format::Auto);
 
bool fileExists(const QString &archivePath, const QString &fileName,
                Format format = Format::Auto);
 
bool extractFile(const QString &archivePath, const QString &fileName,
                 const QString &outputPath = QString(),
                 Format format = Format::Auto);
 
QByteArray extractFileData(const QString &archivePath, const QString &fileName,
                           Format format = Format::Auto);
 
bool extractFiles(const QString &archivePath, const QStringList &fileNames,
                  const QString &outputDirectoryPath,
                  Format format = Format::Auto);
 
bool extractByPattern(const QString &archivePath, const QStringList &patterns,
                      const QString &outputDirectoryPath,
                      QStringList *extractedFiles = nullptr,
                      Format format = Format::Auto);
 
// ============================================================================
// QIODevice-based Operations (streaming)
// ============================================================================
 
bool decompressFromDevice(QIODevice *device, const QString &outputPath,
                          ProgressCallback progress = nullptr,
                          qint64 maxDecompressedBytes = 0);
 
QByteArray decompressFromDevice(QIODevice *device, qint64 maxDecompressedBytes = 0);
 
bool extractFromDevice(QIODevice *device, const QString &outputDirectoryPath,
                       ProgressCallback progress = nullptr,
                       qint64 maxDecompressedBytes = 0);
 
QByteArray extractFileDataFromDevice(QIODevice *device, const QString &fileName);
 
// ============================================================================
// In-Memory Compression (zlib via qCompress/qUncompress)
// ============================================================================
 
enum class CompressionLevel {
    None    = 0,
    Fast    = 1,
    Default = 6,
    Best    = 9
};
 
QByteArray compress(const QByteArray &data,
                    CompressionLevel level = CompressionLevel::Default);
 
QByteArray uncompress(const QByteArray &data);
 
QByteArray compressData(const QByteArray &data,
                        CompressionLevel level = CompressionLevel::Default,
                        int minSize = 256);
 
QByteArray uncompressData(const QByteArray &data, qint64 maxDecompressedSize = 64LL * 1024 * 1024);
 
bool isDataCompressed(const QByteArray &data);
 
int lastCompressionRatio();
 
QByteArray readFile(const QString &filePath, QString *errorString = nullptr,
                    qint64 maxBytes = 0);
 
QString computeFileHash(const QString &filePath,
                        QCryptographicHash::Algorithm algorithm = QCryptographicHash::Sha256);
 
// ============================================================================
// Compressed JSON Helpers
// ============================================================================
 
bool looksLikeCompressedData(const QByteArray &data);
 
QJsonDocument parseCompressedJson(const QByteArray &data, QJsonParseError *error = nullptr);
 
} // namespace QGCCompression