1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2019 The Qt Company Ltd. 4 ** Copyright (C) 2019 Intel Corporation. 5 ** Contact: https://www.qt.io/licensing/ 6 ** 7 ** This file is part of the QtCore module of the Qt Toolkit. 8 ** 9 ** $QT_BEGIN_LICENSE:LGPL$ 10 ** Commercial License Usage 11 ** Licensees holding valid commercial Qt licenses may use this file in 12 ** accordance with the commercial license agreement provided with the 13 ** Software or, alternatively, in accordance with the terms contained in 14 ** a written agreement between you and The Qt Company. For licensing terms 15 ** and conditions see https://www.qt.io/terms-conditions. For further 16 ** information use the contact form at https://www.qt.io/contact-us. 17 ** 18 ** GNU Lesser General Public License Usage 19 ** Alternatively, this file may be used under the terms of the GNU Lesser 20 ** General Public License version 3 as published by the Free Software 21 ** Foundation and appearing in the file LICENSE.LGPL3 included in the 22 ** packaging of this file. Please review the following information to 23 ** ensure the GNU Lesser General Public License version 3 requirements 24 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. 25 ** 26 ** GNU General Public License Usage 27 ** Alternatively, this file may be used under the terms of the GNU 28 ** General Public License version 2.0 or (at your option) the GNU General 29 ** Public license version 3 or any later version approved by the KDE Free 30 ** Qt Foundation. The licenses are as published by the Free Software 31 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 32 ** included in the packaging of this file. Please review the following 33 ** information to ensure the GNU General Public License requirements will 34 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and 35 ** https://www.gnu.org/licenses/gpl-3.0.html. 36 ** 37 ** $QT_END_LICENSE$ 38 ** 39 ****************************************************************************/ 40 41 #ifndef QRESOURCE_H 42 #define QRESOURCE_H 43 44 #include <QtCore/qstring.h> 45 #include <QtCore/qlocale.h> 46 #include <QtCore/qstringlist.h> 47 #include <QtCore/qlist.h> 48 #include <QtCore/qscopedpointer.h> 49 50 QT_BEGIN_NAMESPACE 51 52 53 class QResourcePrivate; 54 55 class Q_CORE_EXPORT QResource 56 { 57 public: 58 enum Compression { 59 NoCompression, 60 ZlibCompression, 61 ZstdCompression 62 }; 63 64 QResource(const QString &file=QString(), const QLocale &locale=QLocale()); 65 ~QResource(); 66 67 void setFileName(const QString &file); 68 QString fileName() const; 69 QString absoluteFilePath() const; 70 71 void setLocale(const QLocale &locale); 72 QLocale locale() const; 73 74 bool isValid() const; 75 76 Compression compressionAlgorithm() const; 77 qint64 size() const; 78 const uchar *data() const; 79 qint64 uncompressedSize() const; 80 QByteArray uncompressedData() const; 81 QDateTime lastModified() const; 82 83 #if QT_DEPRECATED_SINCE(5, 13) 84 QT_DEPRECATED_X("Use QDir::addSearchPath() instead") 85 static void addSearchPath(const QString &path); 86 QT_DEPRECATED_X("Use QDir::searchPaths() instead") 87 static QStringList searchPaths(); 88 #endif 89 #if QT_DEPRECATED_SINCE(5, 15) 90 QT_DEPRECATED_VERSION_X_5_15("Use QResource::compressionAlgorithm() instead") 91 bool isCompressed() const; 92 #endif 93 94 static bool registerResource(const QString &rccFilename, const QString &resourceRoot=QString()); 95 static bool unregisterResource(const QString &rccFilename, const QString &resourceRoot=QString()); 96 97 static bool registerResource(const uchar *rccData, const QString &resourceRoot=QString()); 98 static bool unregisterResource(const uchar *rccData, const QString &resourceRoot=QString()); 99 100 protected: 101 friend class QResourceFileEngine; 102 friend class QResourceFileEngineIterator; 103 bool isDir() const; isFile()104 inline bool isFile() const { return !isDir(); } 105 QStringList children() const; 106 107 protected: 108 QScopedPointer<QResourcePrivate> d_ptr; 109 110 private: 111 Q_DECLARE_PRIVATE(QResource) 112 }; 113 114 QT_END_NAMESPACE 115 116 #endif // QRESOURCE_H 117