QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
qgsziputils.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsziputils.h
3 ---------------------
4 begin : Jul 2017
5 copyright : (C) 2017 by Paul Blottiere
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSZIPUTILS_H
17#define QGSZIPUTILS_H
18
19#include "qgis_core.h"
20#include "qgis_sip.h"
21
22#include <QStringList>
23
29class CORE_EXPORT QgsZipUtils
30{
31 public:
32
39 static bool isZipFile( const QString &filename );
40
49 static bool unzip( const QString &zip, const QString &dir, QStringList &files SIP_OUT, bool checkConsistency = true );
50
60 static bool zip( const QString &zip, const QStringList &files, bool overwrite = false );
61
68 static bool decodeGzip( const QByteArray &bytesIn, QByteArray &bytesOut ) SIP_SKIP;
69
76 static bool decodeGzip( const char *bytesIn, std::size_t size, QByteArray &bytesOut ) SIP_SKIP;
77
84 static bool encodeGzip( const QByteArray &bytesIn, QByteArray &bytesOut ) SIP_SKIP;
85
91 static const QStringList files( const QString &zip );
92
98 static bool extractFileFromZip( const QString &zipFilename, const QString &filenameInZip, QByteArray &bytesOut SIP_OUT );
99
100};
101
102#endif //QGSZIPUTILS_H
Provides utility functions for working with zip files.
Definition qgsziputils.h:30
static bool extractFileFromZip(const QString &zipFilename, const QString &filenameInZip, QByteArray &bytesOut)
Extracts a file from a zip archive, returns true on success.
static bool isZipFile(const QString &filename)
Returns true if the file name is a zipped file ( i.e with a '.qgz' extension, false otherwise.
static bool zip(const QString &zip, const QStringList &files, bool overwrite=false)
Zip the list of files in the zip file.
static bool unzip(const QString &zip, const QString &dir, QStringList &files, bool checkConsistency=true)
Unzip a zip file in an output directory.
static bool decodeGzip(const QByteArray &bytesIn, QByteArray &bytesOut)
Decodes gzip byte stream, returns true on success.
static bool encodeGzip(const QByteArray &bytesIn, QByteArray &bytesOut)
Encodes gzip byte stream, returns true on success.
static const QStringList files(const QString &zip)
Returns the list of files within a zip file.
#define SIP_SKIP
Definition qgis_sip.h:134
#define SIP_OUT
Definition qgis_sip.h:58