tag_repository.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2026 Aurélien PIERRE.
 
    darktable 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 3 of the License, or
    (at your option) any later version.
 
    darktable 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.
 
    You should have received a copy of the GNU General Public License
    along with darktable.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef DT_DATABASE_TAG_REPOSITORY_H
#define DT_DATABASE_TAG_REPOSITORY_H
 
#include "metadata/tags.h"
 
#include <glib.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
G_BEGIN_DECLS
 
GList *dt_tag_repository_get_attached_names(const int32_t imgid);
 
/* ---------------------------------------------------------------------------------------
 *  Identity and lifecycle -- `data.tags`
 * ------------------------------------------------------------------------------------- */
 
guint dt_tag_repository_find_by_name(const char *name);
 
guint dt_tag_repository_find_by_name_nocase(const char *name);
 
guint dt_tag_repository_insert(const char *name);
 
gchar *dt_tag_repository_get_name(const guint tagid);
 
void dt_tag_repository_rename(const guint tagid, const char *new_name);
 
int dt_tag_repository_count_attachments(const guint tagid);
 
void dt_tag_repository_delete(const guint tagid);
 
void dt_tag_repository_delete_batch(const char *id_list);
 
/* ---------------------------------------------------------------------------------------
 *  `memory.darktable_tags` -- the cache of which tags are internal
 * ------------------------------------------------------------------------------------- */
 
void dt_tag_repository_mark_internal(const guint tagid);
 
void dt_tag_repository_rebuild_internal(void);
 
/* ---------------------------------------------------------------------------------------
 *  Flags and synonyms
 * ------------------------------------------------------------------------------------- */
 
gint dt_tag_repository_get_flags(const guint tagid);
 
void dt_tag_repository_set_flags(const guint tagid, const gint flags);
 
void dt_tag_repository_update_flags(const guint tagid, const gint set, const gint keep_mask);
 
gchar *dt_tag_repository_get_synonyms(const guint tagid);
 
void dt_tag_repository_set_synonyms(const guint tagid, const char *synonyms);
 
/* ---------------------------------------------------------------------------------------
 *  Attachments -- `main.tagged_images`
 * ------------------------------------------------------------------------------------- */
 
gboolean dt_tag_repository_attach(const guint tagid, const int32_t imgid);
 
gboolean dt_tag_repository_is_attached(const guint tagid, const int32_t imgid);
 
GList *dt_tag_repository_get_images(const guint tagid);
 
GList *dt_tag_repository_get_images_in_list(const guint tagid, const char *imgid_list);
 
uint32_t dt_tag_repository_count_distinct_images(const guint tagid);
 
void dt_tag_repository_detach_batch(const int32_t imgid, const char *tagid_list);
 
void dt_tag_repository_attach_batch(const char *values);
 
/* ---------------------------------------------------------------------------------------
 *  Attached-tag listings
 *
 *  These return `dt_tag_t` with `id`, `tag`, `flags`, `synonym` and `count` filled.
 *  `leave` (the last path component) and `select` (how much of the selection carries the
 *  tag) are left to the caller: the first is string handling and the second needs the
 *  selection size, which is `common/selection.c`'s to know, not the database's.
 * ------------------------------------------------------------------------------------- */
 
GList *dt_tag_repository_get_attached(const int32_t imgid, const gboolean ignore_internal);
 
GList *dt_tag_repository_get_attached_for_export(const int32_t imgid);
 
typedef enum dt_tag_kind_t
{
  DT_TAG_KIND_ANY = 0,  
  DT_TAG_KIND_INTERNAL, 
  DT_TAG_KIND_USER      
} dt_tag_kind_t;
 
GList *dt_tag_repository_get_ids_for_images(const char *imgid_list, const dt_tag_kind_t kind);
 
GList *dt_tag_repository_get_with_usage(const uint32_t nb_selected);
 
GList *dt_tag_repository_get_collection_tags(void);
 
GList *dt_tag_repository_get_names_under(const int32_t imgid, const char *category);
 
/* ---------------------------------------------------------------------------------------
 *  Keyword search -- a tag and everything under it
 *
 *  Both of these first fill `memory.similar_tags` with the tag whose name equals the
 *  keyword plus every tag whose name starts with `keyword|`, then read from that. The
 *  scratch table is emptied on the way out, as it always was.
 * ------------------------------------------------------------------------------------- */
 
void dt_tag_repository_count_similar(const char *keyword, int *tag_count, int *img_count);
 
void dt_tag_repository_get_similar(const char *keyword, GList **tags, GList **imgids);
 
GList *dt_tag_repository_get_suggestions(const uint32_t nb_selected, const int confidence,
                                         const char *recent_tags, const int nb_recent);
 
void dt_tag_repository_get_agreement(GList *imgids, gboolean *same_tags,
                                     gboolean *same_categories);
 
void dt_tag_repository_cleanup(void);
 
typedef struct dt_tag_count_t
{
  guint id;
  gchar *name; 
  guint count;
} dt_tag_count_t;
 
void dt_tag_count_free(gpointer data);
 
GList *dt_tag_repository_get_by_path_with_counts(const char *path, const char *path_prefix);
 
 
G_END_DECLS
 
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_DATABASE_TAG_REPOSITORY_H
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on