Import QMimeType / QMimeDatabase into QtCore.

History of the development before the import:
ssh://codereview.qt-project.org/playground/mimetypes.git

Mimetype definitions come from shared-mime-info where available (UNIX systems),
loaded using a mmap'ed binary cache generated by update-mime-database.
As a fallback if no cache is found, we parse the raw XML files otherwise.

This makes the MIME type support fast and with very low memory usage on UNIX,
and it makes it easy to use on Windows (no dependency on shared-mime-info,
Qt even includes a freedesktop.xml file to use if none are found on the system).

Change-Id: I27b05008216ff936dc463bd80d3893422bfb940e
Reviewed-by: Richard J. Moore <rich@kde.org>

1 files changed, 165 insertions, 0 deletions

diff --git a/src/corelib/mimetypes/qmimeprovider_p.h b/src/corelib/mimetypes/qmimeprovider_p.h
new file mode 100644
index 0000000000..cb51ba11ee
--- /dev/null
+++ b/src/corelib/mimetypes/qmimeprovider_p.h
@@ -0,0 +1,165 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the QtCore module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QMIMEPROVIDER_P_H
+#define QMIMEPROVIDER_P_H
+
+#include <QtCore/qdatetime.h>
+#include "qmimedatabase_p.h"
+#include <QtCore/qset.h>
+
+QT_BEGIN_NAMESPACE
+
+class QMimeMagicRuleMatcher;
+
+class QMimeProviderBase
+{
+public:
+    QMimeProviderBase(QMimeDatabasePrivate *db);
+    virtual ~QMimeProviderBase() {}
+
+    virtual bool isValid() = 0;
+    virtual QMimeType mimeTypeForName(const QString &name) = 0;
+    virtual QStringList findByFileName(const QString &fileName, QString *foundSuffix) = 0;
+    virtual QStringList parents(const QString &mime) = 0;
+    virtual QString resolveAlias(const QString &name) = 0;
+    virtual QMimeType findByMagic(const QByteArray &data, int *accuracyPtr) = 0;
+    virtual QList<QMimeType> allMimeTypes() = 0;
+    virtual void loadMimeTypePrivate(QMimeTypePrivate &) {}
+    virtual void loadIcon(QMimeTypePrivate &) {}
+    virtual void loadGenericIcon(QMimeTypePrivate &) {}
+
+    QMimeDatabasePrivate *m_db;
+protected:
+    bool shouldCheck();
+    QDateTime m_lastCheck;
+};
+
+/*
+   Parses the files 'mime.cache' and 'types' on demand
+ */
+class QMimeBinaryProvider : public QMimeProviderBase
+{
+public:
+    QMimeBinaryProvider(QMimeDatabasePrivate *db);
+    virtual ~QMimeBinaryProvider();
+
+    virtual bool isValid();
+    virtual QMimeType mimeTypeForName(const QString &name);
+    virtual QStringList findByFileName(const QString &fileName, QString *foundSuffix);
+    virtual QStringList parents(const QString &mime);
+    virtual QString resolveAlias(const QString &name);
+    virtual QMimeType findByMagic(const QByteArray &data, int *accuracyPtr);
+    virtual QList<QMimeType> allMimeTypes();
+    virtual void loadMimeTypePrivate(QMimeTypePrivate &);
+    virtual void loadIcon(QMimeTypePrivate &);
+    virtual void loadGenericIcon(QMimeTypePrivate &);
+
+private:
+    struct CacheFile;
+
+    void matchGlobList(QMimeGlobMatchResult &result, CacheFile *cacheFile, int offset, const QString &fileName);
+    bool matchSuffixTree(QMimeGlobMatchResult &result, CacheFile *cacheFile, int numEntries, int firstOffset, const QString &fileName, int charPos, bool caseSensitiveCheck);
+    bool matchMagicRule(CacheFile *cacheFile, int numMatchlets, int firstOffset, const QByteArray &data);
+    QString iconForMime(CacheFile *cacheFile, int posListOffset, const QByteArray &inputMime);
+    void loadMimeTypeList();
+    void checkCache();
+
+    class CacheFileList : public QList<CacheFile *>
+    {
+    public:
+        CacheFile *findCacheFile(const QString &fileName) const;
+        bool checkCacheChanged();
+    };
+    CacheFileList m_cacheFiles;
+    QStringList m_cacheFileNames;
+    QSet<QString> m_mimetypeNames;
+    bool m_mimetypeListLoaded;
+};
+
+/*
+   Parses the raw XML files (slower)
+ */
+class QMimeXMLProvider : public QMimeProviderBase
+{
+public:
+    QMimeXMLProvider(QMimeDatabasePrivate *db);
+
+    virtual bool isValid();
+    virtual QMimeType mimeTypeForName(const QString &name);
+    virtual QStringList findByFileName(const QString &fileName, QString *foundSuffix);
+    virtual QStringList parents(const QString &mime);
+    virtual QString resolveAlias(const QString &name);
+    virtual QMimeType findByMagic(const QByteArray &data, int *accuracyPtr);
+    virtual QList<QMimeType> allMimeTypes();
+
+    bool load(const QString &fileName, QString *errorMessage);
+
+    // Called by the mimetype xml parser
+    void addMimeType(const QMimeType &mt);
+    void addGlobPattern(const QMimeGlobPattern &glob);
+    void addParent(const QString &child, const QString &parent);
+    void addAlias(const QString &alias, const QString &name);
+    void addMagicMatcher(const QMimeMagicRuleMatcher &matcher);
+
+private:
+    void ensureLoaded();
+    void load(const QString &fileName);
+
+    bool m_loaded;
+
+    typedef QHash<QString, QMimeType> NameMimeTypeMap;
+    NameMimeTypeMap m_nameMimeTypeMap;
+
+    typedef QHash<QString, QString> AliasHash;
+    AliasHash m_aliases;
+
+    typedef QHash<QString, QStringList> ParentsHash;
+    ParentsHash m_parents;
+    QMimeAllGlobPatterns m_mimeTypeGlobs;
+
+    QList<QMimeMagicRuleMatcher> m_magicMatchers;
+    QStringList m_allFiles;
+};
+
+QT_END_NAMESPACE
+
+#endif // QMIMEPROVIDER_P_H