tagscache.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-04-02
 * Description : Cache for Tag information
 *
 * Copyright (C) 2010-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_TAGS_CACHE_H
#define DIGIKAM_TAGS_CACHE_H
 
// Qt includes
 
#include <QObject>
 
// Local includes
 
#include "coredbchangesets.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT TagsCache : public QObject
{
    Q_OBJECT
 
public:
 
    enum LeadingSlashPolicy
    {
        NoLeadingSlash,      
        IncludeLeadingSlash  
    };
 
    enum HiddenTagsPolicy
    {
        NoHiddenTags,
        IncludeHiddenTags
    };
 
public:
 
    QString     tagName(int id) const;
    QStringList tagNames(const QList<int>& ids, HiddenTagsPolicy hiddenTagsPolicy = IncludeHiddenTags)  const;
 
    QString     tagPath(int id, LeadingSlashPolicy slashPolicy = IncludeLeadingSlash)                   const;
    QStringList tagPaths(const QList<int>& ids,
                         LeadingSlashPolicy slashPolicy = IncludeLeadingSlash,
                         HiddenTagsPolicy hiddenTagsPolicy = IncludeHiddenTags)                         const;
 
    bool hasTag(int id)                                                                                 const;
 
    int parentTag(int id)                                                                               const;
 
    QList<int> parentTags(int id)                                                                       const;
 
    QList<int> tagsForName(const QString& tagName, HiddenTagsPolicy hiddenTagsPolicy = NoHiddenTags)    const;
 
    int tagForName(const QString& tagName, int parentId = 0)                                            const;
 
    int tagForPath(const QString& path)                                                                 const;
    QList<int> tagsForPaths(const QStringList& tagPaths)                                                const;
 
    int createTag(const QString& tagPathToCreate);
    QList<int> createTags(const QStringList& tagPaths);
 
    int getOrCreateTag(const QString& tagPath);
    QList<int> getOrCreateTags(const QStringList& tagPaths);
 
    int getOrCreateTagWithProperty(const QString& tagPath,
                                   const QString& property,
                                   const QString& value = QString());
 
    bool hasProperty(int tagId, const QString& property, const QString& value = QString())              const;
 
    QString     propertyValue(int tagId, const QString& property)                                       const;
    QStringList propertyValues(int tagId, const QString& property)                                      const;
 
    QMap<QString, QString> properties(int tagId)                                                        const;
 
    QList<int> tagsWithProperty(const QString& property, const QString& value = QString())              const;
 
    QList<int> tagsWithPropertyCached(const QString& property)                                          const;
 
    bool isInternalTag(int tagId)                                                                       const;
 
    QList<int> publicTags(const QList<int>& tagIds)                                                     const;
 
    bool  containsPublicTags(const QList<int>& tagIds)                                                  const;
 
    bool canBeWrittenToMetadata(int tagId)                                                              const;
 
    int getOrCreateInternalTag(const QString& tagName);
 
    int tagForColorLabel(int label);
 
    QVector<int> colorLabelTags();
 
    int colorLabelForTag(int tagId);
 
    int colorLabelFromTags(QList<int> tagIds);
 
    int tagForPickLabel(int label);
 
    QVector<int> pickLabelTags();
 
    int pickLabelForTag(int tagId);
 
    int pickLabelFromTags(QList<int> tagIds);
 
    QList<int> tagsContaining(const QString& fragment,
                               Qt::CaseSensitivity caseSensitivity = Qt::CaseInsensitive,
                               HiddenTagsPolicy hiddenTagsPolicy = NoHiddenTags);
    QList<int> tagsStartingWith(const QString& begin,
                                Qt::CaseSensitivity caseSensitivity = Qt::CaseInsensitive,
                                HiddenTagsPolicy hiddenTagsPolicy = NoHiddenTags);
 
    QStringList shortenedTagPaths(const QList<int>& ids,
                                  LeadingSlashPolicy slashPolicy = IncludeLeadingSlash,
                                  HiddenTagsPolicy hiddenTagsPolicy = IncludeHiddenTags)                const;
 
    QStringList shortenedTagPaths(const QList<int>& ids, QList<int>* sortedIds,
                                  LeadingSlashPolicy slashPolicy = IncludeLeadingSlash,
                                  HiddenTagsPolicy hiddenTagsPolicy = IncludeHiddenTags)                const;
 
public:
 
    static TagsCache* instance();
 
    static QLatin1String tagPathOfDigikamInternalTags(LeadingSlashPolicy slashPolicy = IncludeLeadingSlash);
    static QLatin1String propertyNameDigikamInternalTag();
    static QLatin1String propertyNameExcludedFromWriting();
 
Q_SIGNALS:
 
    void tagAdded(int tagId);
    void tagDeleted(int tagId);
    void tagAboutToBeDeleted(QString name);
 
private Q_SLOTS:
 
    void slotTagChanged(const TagChangeset& changeset);
 
private:
 
    // Disable
    TagsCache();
    explicit TagsCache(QObject*) = delete;
    ~TagsCache() override;
 
    void initialize();
    void invalidate();
 
private:
 
    friend class CoreDbAccess;
    friend class TagsCacheCreator;
    friend class ChangingDB;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_TAGS_CACHE_H