src/qml/qml/qqmlbundle_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml 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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLBUNDLE_P_H
  43 #define QQMLBUNDLE_P_H
  44
  45 #include <QtCore/qfile.h>
  46 #include <QtCore/qstring.h>
  47 #include <private/qtqmlglobal_p.h>
  48
  49 #ifdef Q_CC_MSVC
  50 // nonstandard extension used : zero-sized array in struct/union.
  51 #  pragma warning( disable : 4200 )
  52 #endif
  53
  54 QT_BEGIN_NAMESPACE
  55
  56 class Q_QML_PRIVATE_EXPORT QQmlBundle
  57 {
  58     Q_DISABLE_COPY(QQmlBundle)
  59 public:
  60     struct Q_QML_PRIVATE_EXPORT Entry
  61     {
  62         enum Kind {
  63             File = 123, // Normal file
  64             Skip,       // Empty space
  65             Link        // A meta data linked file
  66
  67             // ### add entries for qmldir, index, ...
  68         };
  69
  70         int kind;
  71         quint32 size;
  72     };
  73
  74     struct Q_QML_PRIVATE_EXPORT RawEntry : public Entry
  75     {
  76         char data[]; // trailing data
  77     };
  78
  79     struct Q_QML_PRIVATE_EXPORT FileEntry : public Entry
  80     {
  81         quint32 link;
  82         int fileNameLength;
  83         char data[]; // trailing data
  84
  85         QString fileName() const;
  86         bool isFileName(const QString &) const;
  87
  88         quint32 fileSize() const;
  89         const char *contents() const;
  90     };
  91
  92     QQmlBundle(const QString &fileName);
  93     ~QQmlBundle();
  94
  95     bool open(QIODevice::OpenMode mode = QIODevice::ReadWrite);
  96     void close();
  97
  98     QList<const FileEntry *> files() const;
  99     void remove(const FileEntry *entry);
 100     bool add(const QString &fileName);
 101     bool add(const QString &name, const QString &fileName);
 102
 103     bool addMetaLink(const QString &fileName,
 104                      const QString &linkName,
 105                      const QByteArray &data);
 106
 107     const FileEntry *find(const QString &fileName) const;
 108     const FileEntry *find(const QChar *fileName, int length) const;
 109
 110     const FileEntry *link(const FileEntry *, const QString &linkName) const;
 111
 112     static int bundleHeaderLength();
 113     static bool isBundleHeader(const char *, int size);
 114 private:
 115     const Entry *findInsertPoint(quint32 size, qint32 *offset);
 116
 117 private:
 118     QFile file;
 119     uchar *buffer;
 120     quint32 bufferSize;
 121     bool opened:1;
 122     bool headerWritten:1;
 123 };
 124
 125 QT_END_NAMESPACE
 126
 127 #endif // QQMLBUNDLE_P_H