collection_query.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2009-2011 johannes hanika.
    Copyright (C) 2010-2011 Henrik Andersson.
    Copyright (C) 2011-2016 Tobias Ellinghaus.
    Copyright (C) 2012, 2019-2022 Pascal Obry.
    Copyright (C) 2025-2026 Aurelien 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_COLLECTION_QUERY_H
#define DT_DATABASE_COLLECTION_QUERY_H
 
#include <glib.h>
#include <inttypes.h>
 
#include "common/collection.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int (*dt_collection_query_order_resolver_t)(const char *text);
void dt_collection_query_set_order_resolver(dt_collection_query_order_resolver_t fn);
 
void dt_collection_query_set_order_names(const char *const *names, const int count);
 
int dt_collection_query_set_rules(const dt_collection_params_t *params,
                                  const dt_collection_rule_t *rules, const int n_rules,
                                  const uint32_t tagid);
 
int dt_collection_query_recompose(void);
 
void dt_collection_query_refresh_memory_table(void);
 
uint32_t dt_collection_query_count(void);
 
uint64_t dt_collection_query_get_generation(void);
 
typedef struct dt_iop_name_row_t
{
  const char *operation;  
  const char *name;       
} dt_iop_name_row_t;
 
void dt_collection_query_set_iop_names(const dt_iop_name_row_t *rows, const size_t count);
 
GList *dt_collection_query_get_images(const uint32_t limit);
 
int32_t dt_collection_query_get_nth(const int nth);
 
int dt_collection_query_image_offset(const int32_t imgid);
 
void dt_collection_query_push(void);
void dt_collection_query_pop(void);
 
void dt_collection_query_restrict_to_selection(void);
 
GList *dt_collection_query_get_group_members(const int32_t group_id, const int32_t exclude_imgid);
 
typedef struct dt_collection_values_request_t
{
  dt_collection_properties_t property;
  int exclude_rule;              
  gboolean apply_exclude;        
  gboolean metadata_hidden;      
  const char *filmroll_order_by; 
} dt_collection_values_request_t;
 
GList *dt_collection_query_get_property_values(const dt_collection_values_request_t *req);
 
void dt_collection_query_get_makermodels(const gchar *filter, GList **sanitized, GList **exif);
 
GList *dt_collection_query_get_images_for_rule(const dt_collection_properties_t property,
                                               const char *text, gboolean recursive);
 
int32_t dt_collection_query_find_neighbour(GList *imgids);
 
void dt_collection_query_cleanup(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_DATABASE_COLLECTION_QUERY_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