variables.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2009-2011 johannes hanika.
    Copyright (C) 2010, 2012 Henrik Andersson.
    Copyright (C) 2011 Daniel Andersson.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2013 Simon Spannagel.
    Copyright (C) 2015 Jake Probst.
    Copyright (C) 2016 Roman Lebedev.
    Copyright (C) 2016-2017 Tobias Ellinghaus.
    Copyright (C) 2019 Denis Dyakov.
    Copyright (C) 2019-2020, 2022 Philippe Weyland.
    Copyright (C) 2020 Aldric Renaudin.
    Copyright (C) 2020 Pascal Obry.
    Copyright (C) 2021 Mark-64.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2024-2025 Aurélien PIERRE.
    Copyright (C) 2024 Guillaume Stutin.
    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/>.
*/
 
#pragma once
 
#include <glib.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct dt_variables_params_t
{
  const gchar *filename;
 
  const gchar *jobcode;
 
  int32_t imgid;
 
  int sequence;
 
  struct dt_variables_data_t *data;
 
  gboolean escape_markup;
 
  void *img;
 
} dt_variables_params_t;
 
void dt_variables_params_init(dt_variables_params_t **params);
void dt_variables_params_destroy(dt_variables_params_t *params);
void dt_variables_set_max_width_height(dt_variables_params_t *params, int max_width, int max_height);
void dt_variables_set_tags_flags(dt_variables_params_t *params, uint32_t flags);
 
void dt_variables_set_datetime(dt_variables_params_t *params, GDateTime *datetime);
 
char *dt_variables_expand(dt_variables_params_t *params, gchar *source, gboolean iterate);
void dt_variables_reset_sequence(dt_variables_params_t *params);
 
gboolean dt_get_user_pictures_dir(const gchar *homedir, gchar *picdir, size_t picdir_size);
 
#ifdef __cplusplus
}
#endif
 
// 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