1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QZIPREADER_H
41 #define QZIPREADER_H
42 
43 #include <QtGui/private/qtguiglobal_p.h>
44 #include <QtCore/qglobal.h>
45 
46 #ifndef QT_NO_TEXTODFWRITER
47 
48 //
49 //  W A R N I N G
50 //  -------------
51 //
52 // This file is not part of the Qt API.  It exists for the convenience
53 // of the QZipReader class.  This header file may change from
54 // version to version without notice, or even be removed.
55 //
56 // We mean it.
57 //
58 
59 #include <QtCore/qdatetime.h>
60 #include <QtCore/qfile.h>
61 #include <QtCore/qstring.h>
62 
63 QT_BEGIN_NAMESPACE
64 
65 class QZipReaderPrivate;
66 
67 class Q_GUI_EXPORT QZipReader
68 {
69 public:
70     explicit QZipReader(const QString &fileName, QIODevice::OpenMode mode = QIODevice::ReadOnly );
71 
72     explicit QZipReader(QIODevice *device);
73     ~QZipReader();
74 
75     QIODevice* device() const;
76 
77     bool isReadable() const;
78     bool exists() const;
79 
80     struct FileInfo
81     {
FileInfoFileInfo82         FileInfo() noexcept
83             : isDir(false), isFile(false), isSymLink(false), crc(0), size(0)
84         {}
85 
isValidFileInfo86         bool isValid() const noexcept { return isDir || isFile || isSymLink; }
87 
88         QString filePath;
89         uint isDir : 1;
90         uint isFile : 1;
91         uint isSymLink : 1;
92         QFile::Permissions permissions;
93         uint crc;
94         qint64 size;
95         QDateTime lastModified;
96     };
97 
98     QVector<FileInfo> fileInfoList() const;
99     int count() const;
100 
101     FileInfo entryInfoAt(int index) const;
102     QByteArray fileData(const QString &fileName) const;
103     bool extractAll(const QString &destinationDir) const;
104 
105     enum Status {
106         NoError,
107         FileReadError,
108         FileOpenError,
109         FilePermissionsError,
110         FileError
111     };
112 
113     Status status() const;
114 
115     void close();
116 
117 private:
118     QZipReaderPrivate *d;
119     Q_DISABLE_COPY_MOVE(QZipReader)
120 };
121 Q_DECLARE_TYPEINFO(QZipReader::FileInfo, Q_MOVABLE_TYPE);
122 Q_DECLARE_TYPEINFO(QZipReader::Status, Q_PRIMITIVE_TYPE);
123 
124 QT_END_NAMESPACE
125 
126 #endif // QT_NO_TEXTODFWRITER
127 #endif // QZIPREADER_H
128