ground/openpilotgcs/src/plugins/coreplugin/mimedatabase.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       mimedatabase.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  *             Parts by Nokia Corporation (qt-info@nokia.com) Copyright (C) 2009.
   7  * @addtogroup GCSPlugins GCS Plugins
   8  * @{
   9  * @addtogroup CorePlugin Core Plugin
  10  * @{
  11  * @brief The Core GCS plugin
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28
  29 #ifndef MIMEDATABASE_H
  30 #define MIMEDATABASE_H
  31
  32 #include <coreplugin/core_global.h>
  33 #include <QtCore/QStringList>
  34 #include <QtCore/QSharedDataPointer>
  35 #include <QtCore/QSharedPointer>
  36 #include <QtCore/QByteArray>
  37
  38 QT_BEGIN_NAMESPACE
  39 class QIODevice;
  40 class QRegExp;
  41 class QDebug;
  42 class QFileInfo;
  43 QT_END_NAMESPACE
  44
  45 namespace Core {
  46 class MimeTypeData;
  47 class MimeDatabasePrivate;
  48
  49 namespace Internal {
  50 class BaseMimeTypeParser;
  51 class FileMatchContext;
  52 }
  53
  54 /* Magic (file contents) matcher interface. */
  55 class CORE_EXPORT IMagicMatcher {
  56     Q_DISABLE_COPY(IMagicMatcher)
  57 protected:
  58     IMagicMatcher() {}
  59 public:
  60     // Check for a match on contents of a file
  61     virtual bool matches(const QByteArray &data) const = 0;
  62     // Return a priority value from 1..100
  63     virtual int priority() const = 0;
  64     virtual ~IMagicMatcher() {}
  65 };
  66
  67 /* Utility class: A standard Magic match rule based on contents. Provides
  68  * static factory methods for creation (currently only for "string". This can
  69  * be extended to handle "little16"/"big16", etc.). */
  70 class CORE_EXPORT MagicRule {
  71     Q_DISABLE_COPY(MagicRule)
  72 public:
  73     explicit MagicRule(const QByteArray &pattern, int startPos, int endPos);
  74     bool matches(const QByteArray &data) const;
  75
  76     // Convenience factory methods
  77     static MagicRule *createStringRule(const QString &c, int startPos, int endPos);
  78
  79 private:
  80     const QByteArray m_pattern;
  81     const int m_startPos;
  82     const int m_endPos;
  83 };
  84
  85 /* Utility class: A Magic matcher that checks a number of rules based on
  86  * operator "or". It is used for rules parsed from XML files. */
  87 class CORE_EXPORT MagicRuleMatcher : public IMagicMatcher {
  88     Q_DISABLE_COPY(MagicRuleMatcher)
  89 public:
  90     typedef  QSharedPointer<MagicRule> MagicRuleSharedPointer;
  91
  92     MagicRuleMatcher();
  93     void add(const MagicRuleSharedPointer &rule);
  94     virtual bool matches(const QByteArray &data) const;
  95
  96     virtual int priority() const;
  97     void setPriority(int p);
  98
  99 private:
 100     typedef QList<MagicRuleSharedPointer> MagicRuleList;
 101     MagicRuleList m_list;
 102     int m_priority;
 103 };
 104
 105 /* Mime type data used in the OpenPilot GCS. Contains most information from
 106  * standard mime type XML database files.
 107  * Omissions:
 108  * - Only magic of type "string" is supported. In addition, C++ classes
 109  *   derived from IMagicMatcher can be added to check on contents
 110  * - acronyms, language-specific comments
 111  * Extensions:
 112  * - List of suffixes and preferred suffix (derived from glob patterns).
 113  */
 114 class CORE_EXPORT MimeType {
 115 public:
 116     /* Return value of a glob match, which is higher than magic */
 117     enum { GlobMatchPriority = 101 };
 118
 119     MimeType();
 120     MimeType(const MimeType &);
 121     MimeType &operator=(const MimeType &);
 122     ~MimeType();
 123
 124     void clear();
 125     bool isNull() const;
 126     operator bool() const;
 127
 128     bool isTopLevel() const;
 129
 130     QString type() const;
 131     void setType(const QString &type);
 132
 133     QStringList aliases() const;
 134     void setAliases(const QStringList &);
 135
 136     QString comment() const;
 137     void setComment(const QString &comment);
 138
 139     QString localeComment(const QString &locale = QString() /* en, de...*/) const;
 140     void setLocaleComment(const QString &locale, const QString &comment);
 141
 142     QList<QRegExp> globPatterns() const;
 143     void setGlobPatterns(const QList<QRegExp> &);
 144
 145     QStringList subClassesOf() const;
 146     void setSubClassesOf(const QStringList &);
 147
 148     // Extension over standard mime data
 149     QStringList suffixes() const;
 150     void setSuffixes(const QStringList &);
 151
 152     // Extension over standard mime data
 153     QString preferredSuffix() const;
 154     bool setPreferredSuffix(const QString &);
 155
 156     // Check for type or one of the aliases
 157     bool matchesType(const QString &type) const;
 158     // Check glob patterns and magic. Returns the match priority (0 no match,
 159     // 1..100 indicating a magic match or GlobMatchPriority indicating an
 160     // exact glob match).
 161     unsigned matchesFile(const QFileInfo &file) const;
 162
 163     // Return a filter string usable for a file dialog
 164     QString filterString() const;
 165
 166     // Add magic matcher
 167     void addMagicMatcher(const QSharedPointer<IMagicMatcher> &matcher);
 168
 169     friend QDebug operator<<(QDebug d, const MimeType &mt);
 170
 171 private:
 172     explicit MimeType(const MimeTypeData &d);
 173     unsigned matchesFile(Internal::FileMatchContext &c) const;
 174
 175     friend class Internal::BaseMimeTypeParser;
 176     friend class MimeDatabasePrivate;
 177     QSharedDataPointer<MimeTypeData> m_d;
 178 };
 179
 180 /* A Mime data base to which the plugins can add the mime types they handle.
 181  * When adding a "text/plain" to it, the mimetype will receive a magic matcher
 182  * that checks for text files that do not match the globs by heuristics.
 183  *
 184  * A good testcase is to run it over '/usr/share/mime/<*>/<*>.xml' on Linux. */
 185
 186 class CORE_EXPORT MimeDatabase {
 187     Q_DISABLE_COPY(MimeDatabase)
 188 public:
 189     MimeDatabase();
 190
 191     ~MimeDatabase();
 192
 193     bool addMimeTypes(const QString &fileName, QString *errorMessage);
 194     bool addMimeTypes(QIODevice *device, QString *errorMessage);
 195     bool addMimeType(const MimeType &mt);
 196
 197     // Returns a mime type or Null one if none found
 198     MimeType findByType(const QString &type) const;
 199     // Returns a mime type or Null one if none found
 200     MimeType findByFile(const QFileInfo &f) const;
 201
 202     // Convenience
 203     QString preferredSuffixByType(const QString &type) const;
 204     QString preferredSuffixByFile(const QFileInfo &f) const;
 205
 206     // Return all known suffixes
 207     QStringList suffixes() const;
 208     bool setPreferredSuffix(const QString &typeOrAlias, const QString &suffix);
 209
 210     QStringList filterStrings() const;
 211
 212     friend QDebug operator<<(QDebug d, const MimeDatabase &mt);
 213
 214 private:
 215     MimeDatabasePrivate *m_d;
 216 };
 217 } // namespace Core
 218
 219 #endif // MIMEDATABASE_H