file_location.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2010-2011 Henrik Andersson.
    Copyright (C) 2010 johannes hanika.
    Copyright (C) 2010-2011, 2014, 2016 Tobias Ellinghaus.
    Copyright (C) 2011 Moritz Lipp.
    Copyright (C) 2012 Jérémy Rosen.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2016 Pedro Côrte-Real.
    Copyright (C) 2016 Roman Lebedev.
    Copyright (C) 2018 parafin.
    Copyright (C) 2019 Philippe Weyland.
    Copyright (C) 2020 David-Tillmann Schaefer.
    Copyright (C) 2020 Pascal Obry.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2023, 2025 Alynx Zhou.
    Copyright (C) 2025 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_COMMON_FILE_LOCATION_H
#define DT_COMMON_FILE_LOCATION_H
 
#include <gtk/gtk.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
gchar *dt_loc_get_home_dir(const gchar *user);
 
void dt_loc_init(const char *datadir, const char *moduledir, const char *localedir, const char *configdir, const char *cachedir, const char *tmpdir, const char *kerneldir);
void dt_loc_init_datadir(const char *application_directory, const char *datadir);
void dt_loc_init_moduledir(const char *application_directory, const char *moduledir);
void dt_loc_init_localedir(const char *application_directory, const char *localedir);
void dt_loc_init_sharedir(const char* application_directory);
void dt_loc_init_tmp_dir(const char *tmpdir);
void dt_loc_init_user_config_dir(const char *configdir);
void dt_loc_init_user_cache_dir(const char *cachedir);
void dt_loc_init_kerneldir(const char *application_directory, const char *kerneldir);
 
gchar *dt_loc_init_generic(const char *absolute_value, const char *application_directory, const char *default_value);
 
const char *dt_loc_datadir(void);
const char *dt_loc_sharedir(void);
const char *dt_loc_moduledir(void);
const char *dt_loc_localedir(void);
const char *dt_loc_tmpdir(void);
const char *dt_loc_configdir(void);
const char *dt_loc_cachedir(void);
const char *dt_loc_kerneldir(void);
void dt_check_opendir(const char* text, const char* directory);
 
/* temporary backward_compatibility*/
void dt_loc_get_kerneldir(char *kerneldir, size_t bufsize);
void dt_loc_get_datadir(char *datadir, size_t bufsize);
void dt_loc_get_sharedir(char *sharedir, size_t bufsize);
void dt_loc_get_kerneldir(char *kerneldir, size_t bufsize);
void dt_loc_get_moduledir(char *moduledir, size_t bufsize);
void dt_loc_get_localedir(char *localedir, size_t bufsize);
void dt_loc_get_tmp_dir(char *tmpdir, size_t bufsize);
void dt_loc_get_user_config_dir(char *configdir, size_t bufsize);
void dt_loc_get_user_cache_dir(char *cachedir, size_t bufsize);
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_COMMON_FILE_LOCATION_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