kmimetyperepository_p.h

Go to the documentation of this file.

/*  This file is part of the KDE libraries
 *  Copyright (C) 1999 Waldo Bastian <bastian@kde.org>
 *  Copyright (C) 2006-2007 David Faure <faure@kde.org>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 */

#ifndef KMIMETYPEREPOSITORY_H
#define KMIMETYPEREPOSITORY_H

#include "kmimemagicrule_p.h"
#include "kmimeglobsfileparser_p.h"
#include "kmimetype.h"
#include <QReadWriteLock>

class KDECORE_EXPORT KMimeTypeRepository
{
public:
    static KMimeTypeRepository * self();

    KMimeType::Ptr findMimeTypeByName(const QString &_name, KMimeType::FindByNameOption options = KMimeType::DontResolveAlias);

    QString resolveAlias(const QString& mime);

    QString canonicalName(const QString& mime);

    QStringList parents(const QString& mime);

    enum GlobMatchingFlag {
        NoFlag = 0,
        CaseSensitive = 0x1
    };

    QStringList patternsForMimetype(const QString& mimeType);

    void checkEssentialMimeTypes();

    KMimeType::Ptr defaultMimeTypePtr();

    bool useFavIcons();

    int sharedMimeInfoVersion();

    static bool matchFileName( const QString &filename, const QString &pattern );

private: // only for KMimeType and unittests
    friend class KMimeType;
    friend class KMimeFileParserTest;
    friend class KMimeTypeTest;

    QStringList findFromFileName(const QString &filename, QString *matchingExtension = 0);

    KMimeType::Ptr findFromContent(QIODevice* device, int* accuracy, QByteArray& beginning);

    bool checkMimeTypes();

private:
    KMimeTypeRepository();
    ~KMimeTypeRepository();

    typedef QHash<QString, QString> AliasesMap;
    const AliasesMap& aliases();

    QList<KMimeMagicRule> parseMagicFile(QIODevice* file, const QString& fileName) const;

    // Read magic files
    void parseMagic();

    void parseGlobs();

    void findFromOtherPatternList(QStringList& matchingMimeTypes,
                                  const QString &filename,
                                  QString& foundExt,
                                  bool highWeight);

    mutable AliasesMap m_aliases; // alias -> canonicalName

    typedef QHash<QString, QStringList> ParentsMap;
    ParentsMap m_parents;

    typedef QHash<QString, QStringList> PatternsMap;
    PatternsMap m_patterns;

    bool m_parentsMapLoaded;
    bool m_magicFilesParsed;
    mutable bool m_aliasFilesParsed;
    bool m_globsFilesParsed;
    bool m_patternsMapCalculated;
    bool m_mimeTypesChecked;
    bool m_useFavIcons;
    bool m_useFavIconsChecked;
    int m_sharedMimeInfoVersion;
    QList<KMimeMagicRule> m_magicRules;
    KMimeGlobsFileParser::AllGlobs m_globs;
    KMimeType::Ptr m_defaultMimeType;
    QReadWriteLock m_mutex;
};

#endif /* KMIMETYPEREPOSITORY_H */