/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** 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, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qicon.h"

#include "qicon_p.h"

#include "qiconengine.h"

#include "qiconengineplugin.h"

#include "private/qfactoryloader_p.h"

#include "private/qiconloader_p.h"

#include "qapplication.h"

#include "qstyleoption.h"

#include "qpainter.h"

#include "qfileinfo.h"

#include "qstyle.h"

#include "qpixmapcache.h"

#include "qvariant.h"

#include "qcache.h"

#include "qdebug.h"

#include "private/qguiplatformplugin_p.h"

#ifdef Q_WS_MAC

#include <private/qt_mac_p.h>

#include <private/qt_cocoa_helpers_mac_p.h>

#endif

#ifdef Q_WS_X11

#include "private/qt_x11_p.h"

#include "private/qkde_p.h"

#endif

QT_BEGIN_NAMESPACE

/*!

    \enum QIcon::Mode

    This enum type describes the mode for which a pixmap is intended

    to be used. The currently defined modes are:

    \value Normal

         Display the pixmap when the user is

        not interacting with the icon, but the

        functionality represented by the icon is available.

    \value Disabled

         Display the pixmap when the

        functionality represented by the icon is not available.

    \value Active

         Display the pixmap when the

        functionality represented by the icon is available and

        the user is interacting with the icon, for example, moving the

        mouse over it or clicking it.

   \value Selected

        Display the pixmap when the item represented by the icon is

        selected.

*/

/*!

  \enum QIcon::State

  This enum describes the state for which a pixmap is intended to be

  used. The \e state can be:

  \value Off  Display the pixmap when the widget is in an "off" state

  \value On  Display the pixmap when the widget is in an "on" state

*/

static QBasicAtomicInt serialNumCounter = Q_BASIC_ATOMIC_INITIALIZER(1);

QIconPrivate::QIconPrivate()

    : engine(0), ref(1),

    serialNum(serialNumCounter.fetchAndAddRelaxed(1)),

    detach_no(0),

    engine_version(2),

    v1RefCount(0)

{

}

QPixmapIconEngine::QPixmapIconEngine()

{

}

QPixmapIconEngine::QPixmapIconEngine(const QPixmapIconEngine &other)

    : QIconEngineV2(other), pixmaps(other.pixmaps)

{

}

QPixmapIconEngine::~QPixmapIconEngine()

{

}

void QPixmapIconEngine::paint(QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state)

{

    QSize pixmapSize = rect.size();

#if defined(Q_WS_MAC)

    pixmapSize *= qt_mac_get_scalefactor();

#endif

    painter->drawPixmap(rect, pixmap(pixmapSize, mode, state));

}

static inline int area(const QSize &s) { return s.width() * s.height(); }

// returns the smallest of the two that is still larger than or equal to size.

static QPixmapIconEngineEntry *bestSizeMatch( const QSize &size, QPixmapIconEngineEntry *pa, QPixmapIconEngineEntry *pb)

{

    int s = area(size);

    if (pa->size == QSize() && pa->pixmap.isNull()) {

        pa->pixmap = QPixmap(pa->fileName);

        pa->size = pa->pixmap.size();

    }

    int a = area(pa->size);

    if (pb->size == QSize() && pb->pixmap.isNull()) {

        pb->pixmap = QPixmap(pb->fileName);

        pb->size = pb->pixmap.size();

    }

    int b = area(pb->size);

    int res = a;

    if (qMin(a,b) >= s)

        res = qMin(a,b);

    else

        res = qMax(a,b);

    if (res == a)

        return pa;

    return pb;

}

QPixmapIconEngineEntry *QPixmapIconEngine::tryMatch(const QSize &size, QIcon::Mode mode, QIcon::State state)

{

    QPixmapIconEngineEntry *pe = 0;

    for (int i = 0; i < pixmaps.count(); ++i)

        if (pixmaps.at(i).mode == mode && pixmaps.at(i).state == state) {

            if (pe)

                pe = bestSizeMatch(size, &pixmaps[i], pe);

            else

                pe = &pixmaps[i];

        }

    return pe;

}

QPixmapIconEngineEntry *QPixmapIconEngine::bestMatch(const QSize &size, QIcon::Mode mode, QIcon::State state, bool sizeOnly)

{

    QPixmapIconEngineEntry *pe = tryMatch(size, mode, state);

    while (!pe){

        QIcon::State oppositeState = (state == QIcon::On) ? QIcon::Off : QIcon::On;

        if (mode == QIcon::Disabled || mode == QIcon::Selected) {

            QIcon::Mode oppositeMode = (mode == QIcon::Disabled) ? QIcon::Selected : QIcon::Disabled;

            if ((pe = tryMatch(size, QIcon::Normal, state)))

                break;

            if ((pe = tryMatch(size, QIcon::Active, state)))

                break;

            if ((pe = tryMatch(size, mode, oppositeState)))

                break;

            if ((pe = tryMatch(size, QIcon::Normal, oppositeState)))

                break;

            if ((pe = tryMatch(size, QIcon::Active, oppositeState)))

                break;

            if ((pe = tryMatch(size, oppositeMode, state)))

                break;

            if ((pe = tryMatch(size, oppositeMode, oppositeState)))

                break;

        } else {

            QIcon::Mode oppositeMode = (mode == QIcon::Normal) ? QIcon::Active : QIcon::Normal;

            if ((pe = tryMatch(size, oppositeMode, state)))

                break;

            if ((pe = tryMatch(size, mode, oppositeState)))

                break;

            if ((pe = tryMatch(size, oppositeMode, oppositeState)))

                break;

            if ((pe = tryMatch(size, QIcon::Disabled, state)))

                break;

            if ((pe = tryMatch(size, QIcon::Selected, state)))

                break;

            if ((pe = tryMatch(size, QIcon::Disabled, oppositeState)))

                break;

            if ((pe = tryMatch(size, QIcon::Selected, oppositeState)))

                break;

        }

        if (!pe)

            return pe;

    }

    if (sizeOnly ? (pe->size.isNull() || !pe->size.isValid()) : pe->pixmap.isNull()) {

        pe->pixmap = QPixmap(pe->fileName);

        if (!pe->pixmap.isNull())

            pe->size = pe->pixmap.size();

    }

    return pe;

}

QPixmap QPixmapIconEngine::pixmap(const QSize &size, QIcon::Mode mode, QIcon::State state)

{

    QPixmap pm;

    QPixmapIconEngineEntry *pe = bestMatch(size, mode, state, false);

    if (pe)

        pm = pe->pixmap;

    if (pm.isNull()) {

        int idx = pixmaps.count();

        while (--idx >= 0) {

            if (pe == &pixmaps[idx]) {

                pixmaps.remove(idx);

                break;

            }

        }

        if (pixmaps.isEmpty())

            return pm;

        else

            return pixmap(size, mode, state);

    }

    QSize actualSize = pm.size();

    if (!actualSize.isNull() && (actualSize.width() > size.width() || actualSize.height() > size.height()))

        actualSize.scale(size, Qt::KeepAspectRatio);

    QString key = QLatin1String("$qt_icon_")

                  + QString::number(pm.cacheKey())

                  + QString::number(pe->mode)

                  + QString::number(QApplication::palette().cacheKey())

                  + QLatin1Char('_')

                  + QString::number(actualSize.width())

                  + QLatin1Char('_')

                  + QString::number(actualSize.height())

                  + QLatin1Char('_');

    if (mode == QIcon::Active) {

        if (QPixmapCache::find(key + QString::number(mode), pm))

            return pm; // horray

        if (QPixmapCache::find(key + QString::number(QIcon::Normal), pm)) {

            QStyleOption opt(0);

            opt.palette = QApplication::palette();

            QPixmap active = QApplication::style()->generatedIconPixmap(QIcon::Active, pm, &opt);

            if (pm.cacheKey() == active.cacheKey())

                return pm;

        }

    }

    if (!QPixmapCache::find(key + QString::number(mode), pm)) {

        if (pm.size() != actualSize)

            pm = pm.scaled(actualSize, Qt::IgnoreAspectRatio, Qt::SmoothTransformation);

        if (pe->mode != mode && mode != QIcon::Normal) {

            QStyleOption opt(0);

            opt.palette = QApplication::palette();

            QPixmap generated = QApplication::style()->generatedIconPixmap(mode, pm, &opt);

            if (!generated.isNull())

                pm = generated;

        }

        QPixmapCache::insert(key + QString::number(mode), pm);

    }

    return pm;

}

QSize QPixmapIconEngine::actualSize(const QSize &size, QIcon::Mode mode, QIcon::State state)

{

    QSize actualSize;

    if (QPixmapIconEngineEntry *pe = bestMatch(size, mode, state, true))

        actualSize = pe->size;

    if (actualSize.isNull())

        return actualSize;

    if (!actualSize.isNull() && (actualSize.width() > size.width() || actualSize.height() > size.height()))

        actualSize.scale(size, Qt::KeepAspectRatio);

    return actualSize;

}

void QPixmapIconEngine::addPixmap(const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state)

{

    if (!pixmap.isNull()) {

        QPixmapIconEngineEntry *pe = tryMatch(pixmap.size(), mode, state);

        if(pe && pe->size == pixmap.size()) {

            pe->pixmap = pixmap;

            pe->fileName.clear();

        } else {

            pixmaps += QPixmapIconEngineEntry(pixmap, mode, state);

        }

    }

}

void QPixmapIconEngine::addFile(const QString &fileName, const QSize &_size, QIcon::Mode mode, QIcon::State state)

{

    if (!fileName.isEmpty()) {

        QSize size = _size;

        QPixmap pixmap;

        QString abs = fileName;

        if (fileName.at(0) != QLatin1Char(':'))

            abs = QFileInfo(fileName).absoluteFilePath();

        for (int i = 0; i < pixmaps.count(); ++i) {

            if (pixmaps.at(i).mode == mode && pixmaps.at(i).state == state) {

                QPixmapIconEngineEntry *pe = &pixmaps[i];

                if(size == QSize()) {

                    pixmap = QPixmap(abs);

                    size = pixmap.size();

                }

                if (pe->size == QSize() && pe->pixmap.isNull()) {

                    pe->pixmap = QPixmap(pe->fileName);

                    pe->size = pe->pixmap.size();

                }

                if(pe->size == size) {

                    pe->pixmap = pixmap;

                    pe->fileName = abs;

                    return;

                }

            }

        }

        QPixmapIconEngineEntry e(abs, size, mode, state);

        e.pixmap = pixmap;

        pixmaps += e;

    }

}

QString QPixmapIconEngine::key() const

{

    return QLatin1String("QPixmapIconEngine");

}

QIconEngineV2 *QPixmapIconEngine::clone() const

{

    return new QPixmapIconEngine(*this);

}

bool QPixmapIconEngine::read(QDataStream &in)

{

    int num_entries;

    QPixmap pm;

    QString fileName;

    QSize sz;

    uint mode;

    uint state;

    in >> num_entries;

    for (int i=0; i < num_entries; ++i) {

        if (in.atEnd()) {

            pixmaps.clear();

            return false;

        }

        in >> pm;

        in >> fileName;

        in >> sz;

        in >> mode;

        in >> state;

        if (pm.isNull()) {

            addFile(fileName, sz, QIcon::Mode(mode), QIcon::State(state));

        } else {

            QPixmapIconEngineEntry pe(fileName, sz, QIcon::Mode(mode), QIcon::State(state));

            pe.pixmap = pm;

            pixmaps += pe;

        }

    }

    return true;

}

bool QPixmapIconEngine::write(QDataStream &out) const

{

    int num_entries = pixmaps.size();

    out << num_entries;

    for (int i=0; i < num_entries; ++i) {

        if (pixmaps.at(i).pixmap.isNull())

            out << QPixmap(pixmaps.at(i).fileName);

        else

            out << pixmaps.at(i).pixmap;

        out << pixmaps.at(i).fileName;

        out << pixmaps.at(i).size;

        out << (uint) pixmaps.at(i).mode;

        out << (uint) pixmaps.at(i).state;

    }

    return true;

}

void QPixmapIconEngine::virtual_hook(int id, void *data)

{

    switch (id) {

    case QIconEngineV2::AvailableSizesHook: {

        QIconEngineV2::AvailableSizesArgument &arg =

            *reinterpret_cast<QIconEngineV2::AvailableSizesArgument*>(data);

        arg.sizes.clear();

        for (int i = 0; i < pixmaps.size(); ++i) {

            QPixmapIconEngineEntry &pe = pixmaps[i];

            if (pe.size == QSize() && pe.pixmap.isNull()) {

                pe.pixmap = QPixmap(pe.fileName);

                pe.size = pe.pixmap.size();

            }

            if (pe.mode == arg.mode && pe.state == arg.state && !pe.size.isEmpty())

                arg.sizes.push_back(pe.size);

        }

        break;

    }

    default:

        QIconEngineV2::virtual_hook(id, data);

    }

}

#if !defined (QT_NO_LIBRARY) && !defined(QT_NO_SETTINGS)

Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader,

    (QIconEngineFactoryInterface_iid, QLatin1String("/iconengines"), Qt::CaseInsensitive))

Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loaderV2,

    (QIconEngineFactoryInterfaceV2_iid, QLatin1String("/iconengines"), Qt::CaseInsensitive))

#endif

/*!

  \class QIcon

  \brief The QIcon class provides scalable icons in different modes

  and states.

  \ingroup painting

  \ingroup shared

  A QIcon can generate smaller, larger, active, and disabled pixmaps

  from the set of pixmaps it is given. Such pixmaps are used by Qt

  widgets to show an icon representing a particular action.

  The simplest use of QIcon is to create one from a QPixmap file or

  resource, and then use it, allowing Qt to work out all the required

  icon styles and sizes. For example:

  \snippet doc/src/snippets/code/src_gui_image_qicon.cpp 0

  To undo a QIcon, simply set a null icon in its place:

  \snippet doc/src/snippets/code/src_gui_image_qicon.cpp 1

  Use the QImageReader::supportedImageFormats() and

  QImageWriter::supportedImageFormats() functions to retrieve a

  complete list of the supported file formats.

  When you retrieve a pixmap using pixmap(QSize, Mode, State), and no

  pixmap for this given size, mode and state has been added with

  addFile() or addPixmap(), then QIcon will generate one on the

  fly. This pixmap generation happens in a QIconEngineV2. The default

  engine scales pixmaps down if required, but never up, and it uses

  the current style to calculate a disabled appearance. By using

  custom icon engines, you can customize every aspect of generated

  icons. With QIconEnginePluginV2 it is possible to register different

  icon engines for different file suffixes, making it possible for

  third parties to provide additional icon engines to those included

  with Qt.

  \note Since Qt 4.2, an icon engine that supports SVG is included.

  \section1 Making Classes that Use QIcon

  If you write your own widgets that have an option to set a small

  pixmap, consider allowing a QIcon to be set for that pixmap.  The

  Qt class QToolButton is an example of such a widget.

  Provide a method to set a QIcon, and when you draw the icon, choose

  whichever pixmap is appropriate for the current state of your widget.

  For example:

  \snippet doc/src/snippets/code/src_gui_image_qicon.cpp 2

  You might also make use of the \c Active mode, perhaps making your

  widget \c Active when the mouse is over the widget (see \l

  QWidget::enterEvent()), while the mouse is pressed pending the

  release that will activate the function, or when it is the currently

  selected item. If the widget can be toggled, the "On" mode might be

  used to draw a different icon.

  \img icon.png QIcon

  \sa {fowler}{GUI Design Handbook: Iconic Label}, {Icons Example}

*/

/*!

  Constructs a null icon.

*/

QIcon::QIcon()

    : d(0)

{

}

/*!

  Constructs an icon from a \a pixmap.

 */

QIcon::QIcon(const QPixmap &pixmap)

    :d(0)

{

    addPixmap(pixmap);

}

/*!

  Constructs a copy of \a other. This is very fast.

*/