/*
 * Copyright (C) 2015 Dan Leinir Turthra Jensen <admin@leinir.dk>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) version 3, or any
 * later version accepted by the membership of KDE e.V. (or its
 * successor approved by the membership of KDE e.V.), which shall
 * act as a proxy defined in Section 6 of version 3 of the license.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ARCHIVEIMAGEPROVIDER_H
#define ARCHIVEIMAGEPROVIDER_H

#include <QQuickAsyncImageProvider>
#include <QRunnable>

/**
 * \brief Class to return images for archives.
 *
 * ArchiveImageProvider is for getting images out of
 * archives(zip, rar, cbz, cbr), as well as getting image data out of ACBF files.
 */
class ArchiveBookModel;
class ArchiveImageProvider : public QQuickAsyncImageProvider
{
public:
    explicit ArchiveImageProvider();
    ~ArchiveImageProvider() override;

    /**
     * \brief Request a given image.
     *
     * @param id The url of the image to provide.
     * @param requestedSize The required size of the final image, unused.
     *
     * @return an asynchronous image response
     */
    QQuickImageResponse *requestImageResponse(const QString &id, const QSize &requestedSize) override;

    /**
     * \brief Set the ArchiveBookModel to get images for.
     * @param model ArchiveBookModel to get images for.
     */
    void setArchiveBookModel(ArchiveBookModel *model);

    /**
     * \brief Set the prefix.
     * @param prefix The prefix as a string.
     * TODO: What is the prefix and why is it necessary?
     */
    void setPrefix(QString prefix);
    /**
     * @returns the prefix as a QString.
     */
    QString prefix() const;

private:
    class Private;
    Private *d;
};

/**
 * \brief A worker class which does the bulk of the work for PreviewImageProvider
 */
class ArchiveImageRunnable : public QObject, public QRunnable
{
    Q_OBJECT;

public:
    explicit ArchiveImageRunnable(const QString &id, const QSize &requestedSize, ArchiveBookModel *bookModel, const QString &prefix);
    ~ArchiveImageRunnable() override;

    void run() override;

    /**
     * Request that the preview worker abort what it's doing
     */
    Q_SLOT void abort();

    /**
     * \brief Emitted once the preview has been retrieved (successfully or not)
     * @param image The preview image in the requested size (possibly a placeholder)
     */
    Q_SIGNAL void done(QImage image);

private:
    class Private;
    Private *d;
};

#endif // ARCHIVEIMAGEPROVIDER_H
