src/plugins/texteditor/generichighlighter/manager.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  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, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef MANAGER_H
  35 #define MANAGER_H
  36
  37 #include "highlightdefinitionmetadata.h"
  38
  39 #include <coreplugin/mimedatabase.h>
  40
  41 #include <QtCore/QString>
  42 #include <QtCore/QHash>
  43 #include <QtCore/QSet>
  44 #include <QtCore/QUrl>
  45 #include <QtCore/QList>
  46 #include <QtCore/QSharedPointer>
  47 #include <QtCore/QFutureWatcher>
  48 #include <QtNetwork/QNetworkAccessManager>
  49
  50 QT_BEGIN_NAMESPACE
  51 class QFileInfo;
  52 class QStringList;
  53 class QIODevice;
  54 template <class> class QFutureInterface;
  55 QT_END_NAMESPACE
  56
  57 namespace TextEditor {
  58 namespace Internal {
  59
  60 class HighlightDefinition;
  61 class DefinitionDownloader;
  62
  63 // This is the generic highlighter manager. It is not thread-safe.
  64
  65 class Manager : public QObject
  66 {
  67     Q_OBJECT
  68 public:
  69     virtual ~Manager();
  70     static Manager *instance();
  71
  72     QString definitionIdByName(const QString &name) const;
  73     QString definitionIdByMimeType(const QString &mimeType) const;
  74     QString definitionIdByAnyMimeType(const QStringList &mimeTypes) const;
  75
  76     bool isBuildingDefinition(const QString &id) const;
  77
  78     QSharedPointer<HighlightDefinition> definition(const QString &id);
  79     QSharedPointer<HighlightDefinitionMetaData> definitionMetaData(const QString &id) const;
  80
  81     void downloadAvailableDefinitionsMetaData();
  82     void downloadDefinitions(const QList<QUrl> &urls, const QString &savePath);
  83     bool isDownloadingDefinitions() const;
  84
  85     static QSharedPointer<HighlightDefinitionMetaData> parseMetadata(const QFileInfo &fileInfo);
  86
  87 public slots:
  88     void registerMimeTypes();
  89
  90 private slots:
  91     void registerMimeType(int index) const;
  92     void registerMimeTypesFinished();
  93     void downloadAvailableDefinitionsListFinished();
  94     void downloadDefinitionsFinished();
  95
  96 signals:
  97     void mimeTypesRegistered();
  98
  99 private:
 100     Manager();
 101     Q_DISABLE_COPY(Manager)
 102
 103     void gatherDefinitionsMimeTypes(QFutureInterface<Core::MimeType> &future);
 104     QList<HighlightDefinitionMetaData> parseAvailableDefinitionsList(QIODevice *device) const;
 105     void clear();
 106
 107     bool m_downloadingDefinitions;
 108     bool m_registeringMimeTypes;
 109     int m_queuedMimeTypeRegistrations;
 110
 111     QHash<QString, QString> m_idByName;
 112     QHash<QString, QString> m_idByMimeType;
 113     QHash<QString, QSharedPointer<HighlightDefinition> > m_definitions;
 114     QHash<QString, QSharedPointer<HighlightDefinitionMetaData> > m_definitionsMetaData;
 115     QSet<QString> m_isBuilding;
 116
 117     QList<DefinitionDownloader *> m_downloaders;
 118     QNetworkAccessManager m_networkManager;
 119
 120     QFutureWatcher<void> m_downloadWatcher;
 121     QFutureWatcher<Core::MimeType> m_mimeTypeWatcher;
 122
 123     struct PriorityComp
 124     {
 125         bool operator()(const QSharedPointer<HighlightDefinitionMetaData> &a,
 126                         const QSharedPointer<HighlightDefinitionMetaData> &b) {
 127             return a->priority() > b->priority();
 128         }
 129     };
 130
 131 signals:
 132     void definitionsMetaDataReady(const QList<Internal::HighlightDefinitionMetaData>&);
 133     void errorDownloadingDefinitionsMetaData();
 134 };
 135
 136 } // namespace Internal
 137 } // namespace TextEditor
 138
 139 #endif // MANAGER_H