fileactionmngr_p.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-05-05
 * Description : file action manager
 *
 * Copyright (C) 2009-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2011-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * 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_MNGR_PRIVATE_H
#define DIGIKAM_FILE_ACTION_MNGR_PRIVATE_H
 
// Qt includes
 
#include <QMutex>
#include <QSet>
#include <QTimer>
 
// Local includes
 
#include "fileactionmngr.h"
#include "fileworkeriface.h"
#include "fileactionimageinfolist.h"
#include "databaseworkeriface.h"
#include "metadatahub.h"
#include "parallelworkers.h"
 
namespace Digikam
{
 
enum GroupAction
{
    AddToGroup,
    RemoveFromGroup,
    Ungroup
};
 
class Q_DECL_HIDDEN PrivateProgressItemCreator : public QObject,                            // clazy:exclude=ctor-missing-parent-argument
                                                 public FileActionProgressItemCreator
{
    Q_OBJECT
 
public:
 
    ProgressItem* createProgressItem(const QString& action) const override;
    void addProgressItem(ProgressItem* const item) override;
 
    QAtomicInt activeProgressItems;
 
Q_SIGNALS:
 
    void lastItemCompleted();
 
public Q_SLOTS:
 
    void slotProgressItemCompleted();
    void slotProgressItemCanceled(ProgressItem* item);
};
 
// -----------------------------------------------------------------------------------------------------------
 
class Q_DECL_HIDDEN FileActionMngr::Private : public QObject
{
    Q_OBJECT
 
public:
 
    explicit Private(FileActionMngr* const qq);
    ~Private() override;
 
Q_SIGNALS:
 
    void signalTasksFinished();
 
    // Inter-thread signals: connected to database worker slots
    void signalAddTags(const FileActionItemInfoList& infos, const QList<int>& tagIDs);
    void signalRemoveTags(const FileActionItemInfoList& infos, const QList<int>& tagIDs);
    void signalAssignPickLabel(const FileActionItemInfoList& infos, int pickId);
    void signalAssignColorLabel(const FileActionItemInfoList& infos, int colorId);
    void signalAssignRating(const FileActionItemInfoList& infos, int rating);
    void signalSetExifOrientation(const FileActionItemInfoList& infos, int orientation);
    void signalApplyMetadata(const FileActionItemInfoList& infos, DisjointMetadata* hub);
    void signalEditGroup(int groupAction, const ItemInfo& pick, const FileActionItemInfoList& infos);
    void signalTransform(const FileActionItemInfoList& infos, int orientation);
    void signalCopyAttributes(const FileActionItemInfoList& infos, const QStringList& derivedPaths);
 
public:
 
    // -- Signal-emitter glue code --
 
    void assignTags(const FileActionItemInfoList& infos, const QList<int>& tagIDs)
    {
        emit signalAddTags(infos, tagIDs);
    }
 
    void removeTags(const FileActionItemInfoList& infos, const QList<int>& tagIDs)
    {
        emit signalRemoveTags(infos, tagIDs);
    }
 
    void assignPickLabel(const FileActionItemInfoList& infos, int pickId)
    {
        emit signalAssignPickLabel(infos, pickId);
    }
 
    void assignColorLabel(const FileActionItemInfoList& infos, int colorId)
    {
        emit signalAssignColorLabel(infos, colorId);
    }
 
    void assignRating(const FileActionItemInfoList& infos, int rating)
    {
        emit signalAssignRating(infos, rating);
    }
 
    void editGroup(int groupAction, const ItemInfo& pick, const FileActionItemInfoList& infos)
    {
        emit signalEditGroup(groupAction, pick, infos);
    }
 
    void setExifOrientation(const FileActionItemInfoList& infos, int orientation)
    {
        emit signalSetExifOrientation(infos, orientation);
    }
 
    void applyMetadata(const FileActionItemInfoList& infos, DisjointMetadata* hub)
    {
        emit signalApplyMetadata(infos, hub);
    }
 
    void transform(const FileActionItemInfoList& infos, int orientation)
    {
        emit signalTransform(infos, orientation);
    }
 
    void copyAttributes(const FileActionItemInfoList& infos, const QStringList& derivedPaths)
    {
        emit signalCopyAttributes(infos, derivedPaths);
    }
 
public:
 
    // -- Workflow controlling --
 
    bool isActive() const;
 
    bool shallSendForWriting(qlonglong id);
 
    void startingToWrite(const QList<ItemInfo>& infos);
 
    void connectToDatabaseWorker();
    void connectDatabaseToFileWorker();
 
    PrivateProgressItemCreator* dbProgressCreator();
    PrivateProgressItemCreator* fileProgressCreator();
 
public Q_SLOTS:
 
    void slotImageDataChanged(const QString& path, bool removeThumbnails, bool notifyCache);
    void slotSleepTimer();
    void slotLastProgressItemCompleted();
 
public:
 
    QSet<qlonglong>                       scheduledToWrite;
    QString                               dbMessage;
    QString                               writerMessage;
    QMutex                                mutex;
 
    FileActionMngr*                       q;
 
    DatabaseWorkerInterface*              dbWorker;
    ParallelAdapter<FileWorkerInterface>* fileWorker;
 
    QTimer*                               sleepTimer;
 
    PrivateProgressItemCreator            dbProgress;
    PrivateProgressItemCreator            fileProgress;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FILE_ACTION_MNGR_PRIVATE_H