File indexing completed on 2025-01-19 03:56:59

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2010-12-20
  * Description : description of actions when saving a file with versioning
  *
  * SPDX-FileCopyrightText: 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
  * SPDX-FileCopyrightText: 2010      by Martin Klapetek <martin dot klapetek at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_VERSION_FILE_OPERATION_H
 #define DIGIKAM_VERSION_FILE_OPERATION_H
 
 // Qt includes
 
 #include <QFlags>
 #include <QMap>
 #include <QString>
 
 // Local includes
 
 #include "digikam_export.h"
 #include "dimagehistory.h"
 
 class QUrl;
 
 namespace Digikam
 {
 
 class DIGIKAM_EXPORT VersionFileInfo
 {
 public:
 
     explicit VersionFileInfo()
     {
     }
 
     VersionFileInfo(const QString& path, const QString& fileName, const QString& format)
         : path(path),
           fileName(fileName),
           format(format)
     {
     }
 
     bool    isNull() const;
 
     QString filePath() const;
     QUrl    fileUrl() const;
 
     QString path;
     QString fileName;
     QString format;
 };
 
 // -------------------------------------------------------------------------------------------
 
 class DIGIKAM_EXPORT VersionFileOperation
 {
 public:
 
     /** This class describes an operation necessary for storing an
      *  image under version control.
      *  The loadedFile and current history is given to the VersionManager.
      *  The saveFile is the destination of the save operation.
      *  If the loadedFile shall be moved to an intermediate,
      *  the name is given in intermediateForLoadedFile.
      *  The intermediates map may contain name of intermediates
      *  to save the state after action i of the history
      *  (initialResolvedHistory.size() <= i < currentHistory.size() - 1).
      */
 
     explicit VersionFileOperation()
     {
     }
 
 public:
 
     enum Task
     {
         /// saveFile is a new file. Excludes Replace.
         NewFile            = 1 << 0,
         /// loadedFile and saveFile are the same - replace. Excludes NewFile.
         Replace            = 1 << 1,
         /// Similar to Replace, but the new file name differs from the old one, which should be removed
         SaveAndDelete      = 1 << 2,
         /// Move loadedFile to loadedFileToIntermediate
         MoveToIntermediate = 1 << 3,
         /// Store additional snapshots from within history
         StoreIntermediates = 1 << 4
     };
     Q_DECLARE_FLAGS(Tasks, Task)
 
 public:
 
     Tasks                      tasks;
 
     VersionFileInfo            loadedFile;
 
     VersionFileInfo            saveFile;
 
     VersionFileInfo            intermediateForLoadedFile;
 
     QMap<int, VersionFileInfo> intermediates;
 
     /**
      * Returns a list with all saving locations, for main result or intermediates
      */
     QStringList                allFilePaths() const;
 };
 
 } // namespace Digikam
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::VersionFileOperation::Tasks)
 
 #endif // DIGIKAM_VERSION_FILE_OPERATION_H