/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtMimeTypes addon of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, 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, Digia gives you certain additional
** rights.  These rights are described in the Digia 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.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmimetype.h"

#include "qmimetype_p.h"

// ------------------------------------------------------------------------------------------------

/*!
    \typedef QMimeTypeName
    \brief ID of MIME types, e.g. "text/plain" or "text/html"
 */

// ------------------------------------------------------------------------------------------------

/*!
    \class QMimeType
    \brief QMimeType describes the behaviour and information about a specific MIME type.
 */

// ------------------------------------------------------------------------------------------------

/*!
    \fn QMimeType::QMimeType()
    \brief Initializes the attributes with default values that indicate an invalid MIME type.
 */
QMimeType::QMimeType() :
        d_ptr(new QMimeTypePrivate(QMimeTypeName(), QString(), QString(), QList<QString>()))
{}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QMimeType::QMimeType(const QMimeTypeName &theName,
                             const QString &theDisplayName,
                             const QString &theIconUrl,
                             const QList<QString> &theFilenameExtensions);
    \brief Initializes the attributes with the specified values.
    \a theName The ID of the action
    \a theDisplayName The description of the action to be displayed on user interfaces
    \a theIconUrl The file name of an icon image that represents the action
    \a theFilenameExtensions The filename extensions that are known to contain data of the MIME type
 */
QMimeType::QMimeType(const QMimeTypeName &theName,
                     const QString &theDisplayName,
                     const QString &theIconUrl,
                     const QList<QString> &theFilenameExtensions) :
        d_ptr(new QMimeTypePrivate(theName, theDisplayName, theIconUrl, theFilenameExtensions))
{}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QMimeType::QMimeType(const QMimeType &other);
    \brief Initializes the attributes with the data of another MIME type.
    \a other The other MIME type the data of which is copied
 */
QMimeType::QMimeType(const QMimeType &other) :
        d_ptr(new QMimeTypePrivate(*other.d_ptr))
{}

// ------------------------------------------------------------------------------------------------

/*!
    \fn const QMimeType &QMimeType::operator=(const QMimeType &other);
    \brief Assigns the data of another MIME type.
    \a other The other action the data of which is assigned
 */
QMimeType &QMimeType::operator=(const QMimeType &other)
{
    *d_ptr = *other.d_ptr;

    return *this;
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QMimeType::~QMimeType();
    \brief Frees the d_ptr.
 */
QMimeType::~QMimeType()
{}

// ------------------------------------------------------------------------------------------------

/*!
    \fn bool QMimeType::operator==(const QMimeType &other) const;
    \brief Tests for equality with another MIME type
    \a other The other MIME type that is to be compared with
    Returns if the other MIME type not equal.
 */
bool QMimeType::operator==(const QMimeType &other) const
{
    return *d_ptr == *other.d_ptr;
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn bool QMimeType::operator!=(const QMimeType &other) const;
    \brief Tests for non-equality with another MIME type
    \a other The other MIME type that is to be compared with
    Returns if the other MIME type is not equal.
 */

// ------------------------------------------------------------------------------------------------

/*!
    \fn bool QMimeType::isValid() const;
    \brief Checks if the object contains a valid MIME type.
    Returns the result of the check.
 */
bool QMimeType::isValid() const
{
    return !d_ptr->m_Name.isEmpty() &&
           !d_ptr->m_DisplayName.isEmpty() &&
           !d_ptr->m_IconUrl.isEmpty() &&
           !d_ptr->m_FilenameExtensions.isEmpty();
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn const QMimeTypeName &QMimeType::name() const;
    \brief Returns the ID of the MIME type.
 */
const QMimeTypeName &QMimeType::name() const
{
    return d_ptr->m_Name;
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QString QMimeType::displayName() const;
    \brief Returns a description of the MIME type to be displayed on user interfaces.

    The returned text is return in English language. For other languages it is the caller's
    responsibility to get the text translated.
 */
const QString &QMimeType::displayName() const
{
    return d_ptr->m_DisplayName;
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QString QMimeType::iconUrl() const;
    \brief Returns the file name of an icon image that represents the MIME type.

    Returns an empty string if no icon file has been specified during the registration of the
    MIME type.
 */
const QString &QMimeType::iconUrl() const
{
    return d_ptr->m_IconUrl;
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QList<QString> QMimeType::filenameExtensions() const;
    \brief Returns the filename extensions that are known to contain data of the MIME type.
 */
const QList<QString> &QMimeType::filenameExtensions() const
{
    return d_ptr->m_FilenameExtensions;
}