kmimetype.h

Go to the documentation of this file.

/*  This file is part of the KDE libraries
 *  Copyright (C) 1999 Waldo Bastian <bastian@kde.org>
 *                     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 version 2 as published by the Free Software Foundation;
 *
 *  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 __kmimetype_h__
#define __kmimetype_h__

#include <QtCore/QStringList>
#include <QtCore/QList>

#include <kurl.h>
#include <ksycocatype.h>
#include <kservicetype.h>

#include <sys/types.h>
#include <sys/stat.h>

class KMimeTypePrivate;

class KDECORE_EXPORT KMimeType : public KServiceType // TODO KDE5: drop kservicetype inheritance, inherit kshared
{
    Q_DECLARE_PRIVATE( KMimeType )
public:
    typedef KSharedPtr<KMimeType> Ptr;
    typedef QList<Ptr> List;

    virtual ~KMimeType();

    QString iconName( const KUrl &url = KUrl()) const;

    static QString iconNameForUrl( const KUrl & url, mode_t mode = 0 );

    static QString favIconForUrl( const KUrl& url );

    QString comment( const KUrl& url = KUrl() ) const;

    QStringList patterns() const;

    enum FindByNameOption { DontResolveAlias, ResolveAliases = 1 };

    static Ptr mimeType( const QString& name, FindByNameOption options = ResolveAliases );

    static Ptr findByUrl( const KUrl& url, mode_t mode = 0,
                          bool is_local_file = false, bool fast_mode = false,
                          int *accuracy = 0 );
    static Ptr findByPath( const QString& path, mode_t mode = 0,
                           bool fast_mode = false, int* accuracy = 0 );

    static Ptr findByContent( const QByteArray &data, int *accuracy=0 );

    static Ptr findByNameAndContent( const QString& name, const QByteArray& data,
                                     mode_t mode = 0, int *accuracy=0 );

    static Ptr findByContent( QIODevice* device, int* accuracy = 0 );

    static Ptr findByNameAndContent( const QString& name, QIODevice* device,
                                     mode_t mode = 0, int* accuracy = 0 );

    static Ptr findByFileContent( const QString &fileName, int *accuracy=0 );

    static bool isBinaryData( const QString &fileName );

    static bool isBufferBinaryData( const QByteArray &data );

    static List allMimeTypes();

    static QString defaultMimeType();

    static KMimeType::Ptr defaultMimeTypePtr();

    bool isDefault() const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QString parentMimeType() const;
#endif

    QStringList parentMimeTypes() const;

    QStringList allParentMimeTypes() const;

    bool is( const QString& mimeTypeName ) const;

    QString userSpecifiedIconName() const;

    QString mainExtension() const;

    static QString extractKnownExtension( const QString &fileName );

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

    static int sharedMimeInfoVersion();

protected:

    friend class KMimeTypeRepository; // for KMimeType(QString,QString,QString)

    KMimeType( QDataStream& str, int offset );

    KMimeType( const QString& fullpath, const QString& name, const QString& comment );

    KMimeType( KMimeTypePrivate &dd);

    KMimeType( KMimeTypePrivate &dd, const QString& name, const QString& comment );

private:
    // Forbidden nowadays in KMimeType
    int offset() const;
    void save(QDataStream &s);

    void loadInternal( QDataStream& _str);
    static void buildDefaultType();
    static void checkEssentialMimeTypes();
    static KMimeType::Ptr findByUrlHelper( const KUrl& url, mode_t mode,
                                           bool is_local_file, QIODevice* device, int* accuracy );
};

#endif