versionnamingscheme.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-12-20
 * Description : Interface for version file naming
 *
 * Copyright (C) 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2010      by Martin Klapetek <martin dot klapetek 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_VERSION_NAMING_SCHEME_H
#define DIGIKAM_VERSION_NAMING_SCHEME_H
 
// Qt includes
 
#include <QString>
#include <QVariant>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT VersionNamingScheme
{
public:
 
    VersionNamingScheme()                                               = default;
    virtual ~VersionNamingScheme()                                      = default;
 
    virtual QString baseName(const QString& path,
                             const QString& filename,
                             QVariant* counter = nullptr,
                             QVariant* intermediateCounter = nullptr)   = 0;
 
    virtual QString versionFileName(const QString& path,
                                    const QString& baseName,
                                    const QVariant& counter)            = 0;
 
    virtual QString intermediateFileName(const QString& path,
                                         const QString& filename,
                                         const QVariant& version,
                                         const QVariant& counter)       = 0;
 
    virtual QString directory(const QString& path,
                              const QString& filename)                  = 0;
    virtual QString intermediateDirectory(const QString& currentPath,
                                          const QString& fileName)      = 0;
 
    virtual QVariant initialCounter()                                   = 0;
 
    virtual QVariant incrementedCounter(const QVariant& counter)        = 0;
 
private:
 
    Q_DISABLE_COPY(VersionNamingScheme)
};
 
// -----------------------------------------------------------------------------------------------------
 
class Q_DECL_HIDDEN DefaultVersionNamingScheme : public VersionNamingScheme
{
public:
 
    DefaultVersionNamingScheme()                                                                = default;
    virtual ~DefaultVersionNamingScheme()                                                       = default;
 
    virtual QString baseName(const QString& currentPath, const QString& filename,
                             QVariant* counter, QVariant* intermediateCounter)                  override;
    virtual QString versionFileName(const QString& currentPath, const QString& filename,
                                    const QVariant& counter)                                    override;
    virtual QString intermediateFileName(const QString& currentPath, const QString& filename,
                                         const QVariant& version, const QVariant& counter)      override;
    virtual QString directory(const QString& currentPath, const QString& filename)              override;
    virtual QString intermediateDirectory(const QString& currentPath, const QString& fileName)  override;
    virtual QVariant initialCounter()                                                           override;
    virtual QVariant incrementedCounter(const QVariant& counter)                                override;
 
private:
 
    Q_DISABLE_COPY(DefaultVersionNamingScheme)
};
 
} // namespace Digikam
 
#endif // DIGIKAM_VERSION_NAMING_SCHEME_H