fileactionimageinfolist.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2012-02-05
 * Description : file action manager task list
 *
 * Copyright (C) 2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_FILE_ACTION_IMAGE_INFO_LIST_H
#define DIGIKAM_FILE_ACTION_IMAGE_INFO_LIST_H
 
// Qt includes
 
#include <QAtomicPointer>
#include <QList>
#include <QExplicitlySharedDataPointer>
#include <QDebug>
 
// Local includes
 
#include "iteminfo.h"
#include "progressmanager.h"
 
namespace Digikam
{
 
class FileActionProgressItemCreator
{
public:
 
    FileActionProgressItemCreator()                                       = default;
    virtual ~FileActionProgressItemCreator()                              = default;
    virtual ProgressItem* createProgressItem(const QString& action) const = 0;
    virtual void addProgressItem(ProgressItem* const item)                = 0;
 
private:
 
    Q_DISABLE_COPY(FileActionProgressItemCreator)
};
 
// -------------------------------------------------------------------------------------------------------------------
 
class TwoProgressItemsContainer :  public QSharedData
{
protected:
 
    QAtomicPointer<ProgressItem> firstItem;
    QAtomicPointer<ProgressItem> secondItem;
 
protected:
 
    // Note: It is currently not safe to schedule after the framework had a chance to
    // advance all already scheduled items. For this, we'd need to add a mechanism (flag to block completion?)
 
    void scheduleOnProgressItem(QAtomicPointer<ProgressItem>& ptr, int total,
                                const QString& action, FileActionProgressItemCreator* const creator);
    void advance(QAtomicPointer<ProgressItem>& ptr, int n);
};
 
// -------------------------------------------------------------------------------------------------------------------
 
class FileActionProgressItemContainer :public QObject, public TwoProgressItemsContainer
{
    Q_OBJECT
 
public:
 
    FileActionProgressItemContainer();
    void schedulingForDB(int numberOfInfos, const QString& action, FileActionProgressItemCreator* const creator);
    void dbProcessed(int numberOfInfos);
    void dbFinished();
    void schedulingForWrite(int numberOfInfos, const QString& action, FileActionProgressItemCreator* const creator);
    void written(int numberOfInfos);
    void finishedWriting();
 
Q_SIGNALS:
 
    void signalWrittingDone();
 
private:
 
    // Disable
    explicit FileActionProgressItemContainer(QObject*);
};
 
// -------------------------------------------------------------------------------------------------------------------
 
class FileActionItemInfoList : public QList<ItemInfo>
{
public:
 
    FileActionItemInfoList()
    {
    }
 
    FileActionItemInfoList(const FileActionItemInfoList& copy)
        : QList    (copy),
          container(copy.container)
    {
    }
 
    ~FileActionItemInfoList()
    {
    }
 
public:
 
    static FileActionItemInfoList create(const QList<ItemInfo>& list);
    static FileActionItemInfoList continueTask(const QList<ItemInfo>& list,
                                               FileActionProgressItemContainer* const container);
 
    FileActionProgressItemContainer* progress() const
    {
        return container.data();
    }
 
    void schedulingForDB(int numberOfInfos,
                         const QString& action,
                         FileActionProgressItemCreator* const creator)
    {
        progress()->schedulingForDB(numberOfInfos, action, creator);
    }
 
    void schedulingForDB(const QString& action,
                         FileActionProgressItemCreator* const creator)
    {
        schedulingForDB(size(), action, creator);
    }
 
    void dbProcessedOne()               const { dbProcessed(1);                         }
    void dbProcessed(int numberOfInfos) const { progress()->dbProcessed(numberOfInfos); }
    void dbFinished()                   const { progress()->dbFinished();               }
 
    void schedulingForWrite(int numberOfInfos,
                            const QString& action,
                            FileActionProgressItemCreator* const creator) const
    {
        progress()->schedulingForWrite(numberOfInfos, action, creator);
    }
 
    void schedulingForWrite(const QString& action,
                            FileActionProgressItemCreator* const creator) const
    {
        schedulingForWrite(size(), action, creator);
    }
 
    void writtenToOne()             const    { written(1);                             }
    void written(int numberOfInfos) const    { progress()->written(numberOfInfos);     }
    void finishedWriting()          const    { progress()->finishedWriting();          }
 
public:
 
    QExplicitlySharedDataPointer<FileActionProgressItemContainer> container;
 
private:
 
    explicit FileActionItemInfoList(const QList<ItemInfo>& list)
        : QList<ItemInfo>(list)
    {
    }
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::FileActionItemInfoList)
 
#endif // DIGIKAM_FILE_ACTION_IMAGE_INFO_LIST_H