common/conf.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2010-2011, 2014 Henrik Andersson.
    Copyright (C) 2010-2013 johannes hanika.
    Copyright (C) 2010, 2012-2017 Tobias Ellinghaus.
    Copyright (C) 2012 Christian Tellefsen.
    Copyright (C) 2012 Jérémy Rosen.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2012 Simon Spannagel.
    Copyright (C) 2012, 2014 Ulrich Pegelow.
    Copyright (C) 2013 Jean-Sébastien Pédron.
    Copyright (C) 2013 Jesper Pedersen.
    Copyright (C) 2014 parafin.
    Copyright (C) 2014, 2020-2021 Pascal Obry.
    Copyright (C) 2014, 2016 Roman Lebedev.
    Copyright (C) 2016-2018 Peter Budai.
    Copyright (C) 2019 jakubfi.
    Copyright (C) 2020 Hubert Kowalski.
    Copyright (C) 2020 Philippe Weyland.
    Copyright (C) 2021 Marco Carrarini.
    Copyright (C) 2021 Mark-64.
    Copyright (C) 2021 Ralf Brown.
    Copyright (C) 2022 Hanno Schwalm.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2025 Alynx Zhou.
    
    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_COMMON_CONF_H
#define DT_COMMON_CONF_H
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#include "system/dtpthread.h"
#include "common/paths.h"   // DT_PATH_MAX
 
#include <glib.h>
#include <gtk/gtk.h>
#include <inttypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum dt_confgen_type_t
{
  DT_INT,
  DT_INT64,
  DT_FLOAT,
  DT_BOOL,
  DT_PATH,
  DT_STRING,
  DT_ENUM
} dt_confgen_type_t;
 
typedef struct dt_confgen_value_t
{
  dt_confgen_type_t type;
  char *def;
  char *min;
  char *max;
  char *enum_values;
  char *shortdesc;
  char *longdesc;
} dt_confgen_value_t;
 
typedef struct dt_conf_t
{
  dt_pthread_mutex_t mutex;
  char filename[DT_PATH_MAX];
  GHashTable *table;
  GHashTable *x_confgen;
  GHashTable *override_entries;
  GPtrArray *retired_values;
} dt_conf_t;
 
typedef struct dt_conf_string_entry_t
{
  char *key;
  char *value;
} dt_conf_string_entry_t;
 
typedef enum dt_confgen_value_kind_t
{
  DT_DEFAULT,
  DT_MIN,
  DT_MAX,
  DT_VALUES
} dt_confgen_value_kind_t;
 
uint64_t dt_conf_generation(void);
 
void dt_conf_set_int(const char *name, int val);
void dt_conf_set_int64(const char *name, int64_t val);
void dt_conf_set_float(const char *name, float val);
void dt_conf_set_bool(const char *name, int val);
void dt_conf_set_string(const char *name, const char *val);
void dt_conf_set_folder_from_file_chooser(const char *name, GtkFileChooser *chooser);
/* The _fast readers return the STORED value. The plain readers return the same value
 * CLAMPED to the min/max declared for that key in the generated XML, at the cost of two
 * extra confgen lookups. "fast" therefore means "unclamped": for any key that declares
 * bounds, the two can disagree, and a value out of range is exactly the case where it
 * matters. Prefer the plain reader unless the key has no bounds or the caller clamps.
 *
 * All of them accept an arithmetic expression as the stored text -- it goes through the
 * calculator -- and fall back to the XML default, then to 0, when it does not parse. */
 
int dt_conf_get_int_fast(const char *name);
int dt_conf_get_int(const char *name);
int64_t dt_conf_get_int64_fast(const char *name);
int64_t dt_conf_get_int64(const char *name);
float dt_conf_get_float_fast(const char *name);
float dt_conf_get_float(const char *name);
int dt_conf_get_and_sanitize_int(const char *name, int min, int max);
int64_t dt_conf_get_and_sanitize_int64(const char *name, int64_t min, int64_t max);
float dt_conf_get_and_sanitize_float(const char *name, float min, float max);
int dt_conf_get_bool(const char *name);
const char *dt_conf_get_string_const(const char *name);
 
gchar *dt_conf_get_string(const char *name);
gboolean dt_conf_get_folder_to_file_chooser(const char *name, GtkFileChooser *chooser);
gboolean dt_conf_is_equal(const char *name, const char *value);
void dt_conf_init(dt_conf_t *cf, const char *filename, GSList *override_entries);
 
void dt_conf_cleanup(dt_conf_t *cf);
 
void dt_conf_save(dt_conf_t *cf);
 
int dt_conf_key_exists(const char *key);
gboolean dt_conf_key_not_empty(const char *key);
GSList *dt_conf_all_string_entries(const char *dir);
 
void dt_conf_string_entry_free(gpointer data);
 
/* These three carry their own trailing semicolon, so a call site that adds one produces an
 * empty statement -- harmless alone, but it makes `if(c) DT_CONF_SET_SANITIZED_INT(...);
 * else ...` fail to compile. Brace the branch. */
 
#define DT_CONF_SET_SANITIZED_INT(name, val, min, max) dt_conf_set_int(name, CLAMPS(val, min,max));
 
#define DT_CONF_SET_SANITIZED_INT6464(name, val, min, max) dt_conf_set_int(name, CLAMPS(val, min,max));
 
#define DT_CONF_SET_SANITIZED_FLOAT(name, val, min, max) dt_conf_set_float(name, CLAMPS(val, min,max));
 
// conf generated from darktable config XML
 
gboolean dt_confgen_exists(const char *name);
dt_confgen_type_t dt_confgen_type(const char *name);
 
gboolean dt_confgen_value_exists(const char *name, dt_confgen_value_kind_t kind);
 
int dt_confgen_get_int(const char *name, dt_confgen_value_kind_t kind);
int64_t dt_confgen_get_int64(const char *name, dt_confgen_value_kind_t kind);
gboolean dt_confgen_get_bool(const char *name, dt_confgen_value_kind_t kind);
float dt_confgen_get_float(const char *name, dt_confgen_value_kind_t kind);
const char *dt_confgen_get(const char *name, dt_confgen_value_kind_t kind);
 
const char *dt_confgen_get_label(const char *name);
 
const char *dt_confgen_get_tooltip(const char *name);
 
gboolean dt_conf_is_default(const char *name);
 
gchar* dt_conf_expand_default_dir(const char *dir);
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_COMMON_CONF_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