folder_survey.h

Go to the documentation of this file.

/*
    This file is part of the Ansel project.
    Copyright (C) 2026 Guillaume STUTIN.
 
    Ansel 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.
*/
 
#ifndef DT_COMMON_FOLDER_SURVEY_H
#define DT_COMMON_FOLDER_SURVEY_H
 
#include <glib.h>
 
#define DT_FOLDER_SURVEY_STYLES_CONF_KEY "studio_capture/styles"
#define DT_FOLDER_SURVEY_STYLES_SEPARATOR "\x1f"
 
void dt_folder_survey_init();
 
int dt_folder_survey_start();
 
void dt_folder_survey_halt();
 
gboolean dt_folder_survey_is_active();
 
gboolean dt_folder_survey_can_start(const char **message);
 
gboolean dt_folder_survey_session_was_active();
 
char *dt_folder_survey_destination_preview();
 
int dt_folder_survey_count_new_files();
 
void dt_folder_survey_absorb_new_files();
 
/* Two questions this module needs a user for, and cannot ask itself.
 *
 * The resume-at-startup prompt is pure GUI orchestration (ask, switch view, start) and
 * lives whole in gui/common/folder_survey_gui.c; only the session marker below is backend.
 * The pending-import prompt is interleaved with private session state, so it is inverted
 * instead: the backend asks through a handler the GUI registers.
 */
 
typedef gboolean (*dt_folder_survey_confirm_import_handler_t)(int new_files);
 
void dt_folder_survey_set_confirm_import_handler(dt_folder_survey_confirm_import_handler_t handler);
 
gboolean dt_folder_survey_take_session_marker();
 
void dt_folder_survey_forget_session();
 
void dt_folder_survey_stop();
 
void dt_folder_survey_cleanup();
#endif // DT_COMMON_FOLDER_SURVEY_H