textnotes.c File Reference

#include "common/darktable.h"
#include "common/datetime.h"
#include "common/debug.h"
#include "common/image.h"
#include "common/image_cache.h"
#include "common/variables.h"
#include "control/control.h"
#include "control/jobs.h"
#include "control/signal.h"
#include "gui/gtk.h"
#include "gui/gtkentry.h"
#include "libs/lib.h"
#include "views/view.h"
#include <glib.h>
#include <glib/gstdio.h>
#include <limits.h>
#include <stdlib.h>
#include <string.h>

Include dependency graph for textnotes.c:

Data Structures
struct	dt_lib_textnotes_t
struct	dt_textnotes_load_job_t
struct	dt_textnotes_load_result_t

Typedefs
typedef struct dt_lib_textnotes_t	dt_lib_textnotes_t
typedef struct dt_textnotes_load_job_t	dt_textnotes_load_job_t
typedef struct dt_textnotes_load_result_t	dt_textnotes_load_result_t

Functions
const char *	name (dt_lib_module_t *self)
const char **	views (dt_lib_module_t *self)
uint32_t	container (dt_lib_module_t *self)
int	position ()
static void	_save_now (dt_lib_module_t *self)
static void	_render_preview (dt_lib_textnotes_t *d, const char *text)
static void	_update_for_current_image (dt_lib_module_t *self)
static gboolean	_image_has_txt_flag (const int32_t imgid)
static gboolean	_set_image_paths (dt_lib_textnotes_t *d, const int32_t imgid)
static void	_clear_variables_cache (dt_lib_textnotes_t *d)
static gboolean	_textnotes_load_finish_idle (gpointer user_data)
static int32_t	_textnotes_load_job_run (dt_job_t *job)
static void	_textnotes_load_job_state (dt_job_t *job, dt_job_state_t state)
static void	_textnotes_load_job_cleanup (void *data)
static gchar *	_get_buffer_text (GtkTextBuffer *buffer)
static gchar *	_get_edit_text (dt_lib_textnotes_t *d)
static void	_set_edit_text (dt_lib_textnotes_t *d, const char *text)
void *	get_params (dt_lib_module_t *self, int *size)
int	set_params (dt_lib_module_t *self, const void *params, int size)
void	init_presets (dt_lib_module_t *self)
static int	_preview_text_window_width_px (dt_lib_textnotes_t *d)
static void	_render_preview_from_edit (dt_lib_textnotes_t *d)
static void	_completion_hide (dt_lib_textnotes_t *d)
static gboolean	_completion_match (const char *item, const char *prefix)
static void	_completion_fill (dt_lib_textnotes_t *d, const char *prefix)
static gboolean	_completion_find_prefix (dt_lib_textnotes_t *d, GtkTextIter *cursor, GtkTextIter *start_iter, gchar **prefix_out)
static gboolean	_completion_apply_selected (dt_lib_module_t *self)
static void	_completion_update (dt_lib_module_t *self)
static gboolean	_completion_focus_out_idle (gpointer user_data)
static gboolean	_edit_key_press (GtkWidget *widget, GdkEventKey *event, dt_lib_module_t *self)
static gboolean	_edit_key_release (GtkWidget *widget, GdkEventKey *event, dt_lib_module_t *self)
static gboolean	_edit_button_release (GtkWidget *widget, GdkEventButton *event, dt_lib_module_t *self)
static void	_completion_row_activated (GtkTreeView *tree, GtkTreePath *path, GtkTreeViewColumn *column, dt_lib_module_t *self)
static void	_setup_completion (dt_lib_module_t *self, GtkWidget *textview)
static gboolean	_alloc_row_buffers (const int width, guchar **row_in, guchar **row_out)
static void	_free_row_buffers (guchar *row_in, guchar *row_out)
static void	_colorcorrect_row (cmsHTRANSFORM transform, guchar *src, const int width, const int n_channels, const gboolean has_alpha, guchar *row_in, guchar *row_out)
static void	_colorcorrect_pixbuf (GdkPixbuf *pixbuf)
static void	_toggle_mode (GtkToggleButton *button, dt_lib_module_t *self)
static void	_load_for_image (dt_lib_module_t *self, const int32_t imgid)
static gboolean	_refresh_preview_idle (gpointer user_data)
static void	_open_uri (const char *uri)
static gchar *	_expand_text_for_preview (dt_lib_textnotes_t *d, const char *source_text)
static void	_clear_mtime_label (dt_lib_textnotes_t *d)
static void	_update_mtime_label (dt_lib_module_t *self)
static void	_toggle_checklist_at_line (dt_lib_module_t *self, const int line_no)
static gboolean	_preview_button_press (GtkWidget *widget, GdkEventButton *event, dt_lib_module_t *self)
static void	_preview_map (GtkWidget *widget, dt_lib_module_t *self)
static void	_edit_map (GtkWidget *widget, dt_lib_module_t *self)
static gboolean	_initial_load_idle (gpointer user_data)
static void	_ensure_has_txt_flag (const int32_t imgid)
static char *	_text_sidecar_save_path (dt_lib_textnotes_t *d, const int32_t imgid)
static void	_save_and_render (dt_lib_module_t *self)
static gboolean	_save_timeout_cb (gpointer user_data)
static void	_textbuffer_changed (GtkTextBuffer *buffer, dt_lib_module_t *self)
static gboolean	_textview_focus_out (GtkWidget *widget, GdkEventFocus *event, dt_lib_module_t *self)
static void	_image_changed_callback (gpointer instance, gpointer user_data)
static void	_mouse_over_image_callback (gpointer instance, gpointer user_data)
void	gui_init (dt_lib_module_t *self)
void	gui_cleanup (dt_lib_module_t *self)

Typedef Documentation

dt_lib_textnotes_t

typedef struct dt_lib_textnotes_t dt_lib_textnotes_t

dt_textnotes_load_job_t

typedef struct dt_textnotes_load_job_t dt_textnotes_load_job_t

dt_textnotes_load_result_t

typedef struct dt_textnotes_load_result_t dt_textnotes_load_result_t

Function Documentation

_alloc_row_buffers()

static gboolean _alloc_row_buffers ( const int  width, guchar **  row_in, guchar **  row_out  )

static

References dt_free, FALSE, TRUE, and width.

Referenced by _colorcorrect_pixbuf().

_clear_mtime_label()

static void _clear_mtime_label ( dt_lib_textnotes_t *  d )

static

References d, and FALSE.

Referenced by _load_for_image(), _textnotes_load_finish_idle(), and _update_mtime_label().

_clear_variables_cache()

static void _clear_variables_cache ( dt_lib_textnotes_t *  d )

static

References d, and dt_variables_params_destroy().

Referenced by _load_for_image(), and gui_cleanup().

_colorcorrect_pixbuf()

static void _colorcorrect_pixbuf ( GdkPixbuf *  pixbuf )

static

References _alloc_row_buffers(), _colorcorrect_row(), _free_row_buffers(), darktable_t::color_profiles, darktable, dt_free, FALSE, height, i, omp_get_max_threads, omp_get_thread_num, transform(), dt_colorspaces_t::transform_srgb_to_display, TRUE, width, and dt_colorspaces_t::xprofile_lock.

_colorcorrect_row()

static void _colorcorrect_row ( cmsHTRANSFORM  transform, guchar *  src, const int  width, const int  n_channels, const gboolean  has_alpha, guchar *  row_in, guchar *  row_out  )

static

References d, transform(), width, and x.

Referenced by _colorcorrect_pixbuf().

_completion_apply_selected()

static gboolean _completion_apply_selected ( dt_lib_module_t *  self )

static

References _completion_hide(), COMPL_VARNAME, d, dt_lib_module_t::data, dt_free, FALSE, model, and TRUE.

Referenced by _completion_row_activated(), and _edit_key_press().

_completion_fill()

static void _completion_fill ( dt_lib_textnotes_t *  d, const char *  prefix  )

static

References _completion_match(), COMPL_DESCRIPTION, COMPL_VARNAME, d, dt_gtkentry_get_default_path_compl_list(), and completion_spec::varname.

Referenced by _completion_update().

_completion_find_prefix()

static gboolean _completion_find_prefix ( dt_lib_textnotes_t *  d, GtkTextIter *  cursor, GtkTextIter *  start_iter, gchar **  prefix_out  )

static

References d, dt_free, FALSE, p, and TRUE.

Referenced by _completion_update().

_completion_focus_out_idle()

static gboolean _completion_focus_out_idle ( gpointer  user_data )

static

References _completion_hide(), _save_now(), d, and dt_lib_module_t::data.

Referenced by _textview_focus_out().

_completion_hide()

static void _completion_hide ( dt_lib_textnotes_t *  d )

static

References d.

Referenced by _completion_apply_selected(), _completion_focus_out_idle(), _completion_update(), _edit_key_press(), and _toggle_mode().

_completion_match()

static gboolean _completion_match ( const char *  item, const char *  prefix  )

static

References dt_free, FALSE, and TRUE.

Referenced by _completion_fill().

_completion_row_activated()

static void _completion_row_activated ( GtkTreeView *  tree, GtkTreePath *  path, GtkTreeViewColumn *  column, dt_lib_module_t *  self  )

static

References _completion_apply_selected(), and void().

Referenced by _setup_completion().

_completion_update()

static void _completion_update ( dt_lib_module_t *  self )

static

References _completion_fill(), _completion_find_prefix(), _completion_hide(), d, dt_lib_module_t::data, dt_free, model, TRUE, rect::width, rect::x, and rect::y.

Referenced by _edit_button_release(), _edit_key_release(), and _textbuffer_changed().

_edit_button_release()

static gboolean _edit_button_release ( GtkWidget *  widget, GdkEventButton *  event, dt_lib_module_t *  self  )

static

References _completion_update(), FALSE, and void().

Referenced by gui_init().

_edit_key_press()

static gboolean _edit_key_press ( GtkWidget *  widget, GdkEventKey *  event, dt_lib_module_t *  self  )

static

References _completion_apply_selected(), _completion_hide(), d, dt_lib_module_t::data, FALSE, TRUE, and void().

Referenced by gui_init().

_edit_key_release()

static gboolean _edit_key_release ( GtkWidget *  widget, GdkEventKey *  event, dt_lib_module_t *  self  )

static

References _completion_update(), FALSE, and void().

Referenced by gui_init().

_edit_map()

static void _edit_map ( GtkWidget *  widget, dt_lib_module_t *  self  )

static

References _update_for_current_image().

Referenced by gui_init().

_ensure_has_txt_flag()

static void _ensure_has_txt_flag ( const int32_t  imgid )

static

References darktable, dt_image_cache_get(), DT_IMAGE_CACHE_SAFE, dt_image_cache_write_release(), DT_IMAGE_HAS_TXT, dt_image_t::flags, and darktable_t::image_cache.

Referenced by _save_and_render(), and _textnotes_load_finish_idle().

_expand_text_for_preview()

static gchar * _expand_text_for_preview ( dt_lib_textnotes_t *  d, const char *  source_text  )

static

References _set_image_paths(), d, dt_free, dt_variables_expand(), dt_variables_params_init(), dt_variables_params_t::escape_markup, FALSE, dt_variables_params_t::filename, dt_variables_params_t::imgid, dt_variables_params_t::jobcode, dt_variables_params_t::sequence, and TRUE.

Referenced by _render_preview().

_free_row_buffers()

static void _free_row_buffers ( guchar *  row_in, guchar *  row_out  )

static

References dt_free.

Referenced by _colorcorrect_pixbuf().

_get_buffer_text()

static gchar * _get_buffer_text ( GtkTextBuffer *  buffer )

static

References TRUE.

Referenced by _get_edit_text(), and _toggle_checklist_at_line().

_get_edit_text()

static gchar * _get_edit_text ( dt_lib_textnotes_t *  d )

static

References _get_buffer_text(), and d.

Referenced by _render_preview_from_edit(), _save_and_render(), _toggle_mode(), and get_params().

_image_changed_callback()

static void _image_changed_callback ( gpointer  instance, gpointer  user_data  )

static

References _update_for_current_image().

Referenced by gui_cleanup(), and gui_init().

_image_has_txt_flag()

static gboolean _image_has_txt_flag ( const int32_t  imgid )

static

References darktable, dt_image_cache_get(), dt_image_cache_read_release(), DT_IMAGE_HAS_TXT, FALSE, dt_image_t::flags, and darktable_t::image_cache.

Referenced by _load_for_image(), and _update_mtime_label().

_initial_load_idle()

static gboolean _initial_load_idle ( gpointer  user_data )

static

References _update_for_current_image(), d, and dt_lib_module_t::data.

Referenced by gui_init().

_load_for_image()

static void _load_for_image ( dt_lib_module_t *  self, const int32_t  imgid  )

static

References _clear_mtime_label(), _clear_variables_cache(), _image_has_txt_flag(), _set_edit_text(), _text_sidecar_save_path(), _textnotes_load_job_cleanup(), _textnotes_load_job_run(), _textnotes_load_job_state(), darktable_t::control, d, darktable, dt_lib_module_t::data, dt_control_add_job(), dt_control_job_create(), dt_control_job_set_params(), dt_control_job_set_state_callback(), dt_free, DT_JOB_QUEUE_USER_BG, FALSE, and TRUE.

Referenced by _update_for_current_image().

_mouse_over_image_callback()

static void _mouse_over_image_callback ( gpointer  instance, gpointer  user_data  )

static

References _update_for_current_image().

Referenced by gui_cleanup(), and gui_init().

_open_uri()

static void _open_uri ( const char *  uri )

static

References darktable, dt_control_log(), dt_ui_main_window(), error(), darktable_t::gui, and dt_gui_gtk_t::ui.

Referenced by _preview_button_press().

_preview_button_press()

static gboolean _preview_button_press ( GtkWidget *  widget, GdkEventButton *  event, dt_lib_module_t *  self  )

static

References _open_uri(), _toggle_checklist_at_line(), FALSE, t, TRUE, and view().

Referenced by gui_init().

_preview_map()

static void _preview_map ( GtkWidget *  widget, dt_lib_module_t *  self  )

static

References _render_preview_from_edit(), d, dt_lib_module_t::data, and void().

Referenced by gui_init().

_preview_text_window_width_px()

static int _preview_text_window_width_px ( dt_lib_textnotes_t *  d )

static

References d.

_refresh_preview_idle()

static gboolean _refresh_preview_idle ( gpointer  user_data )

static

References _render_preview_from_edit(), d, and dt_lib_module_t::data.

_render_preview()

static void _render_preview ( dt_lib_textnotes_t *  d, const char *  text  )

static

References _expand_text_for_preview(), d, dt_free, dt_lib_gui_get_expanded(), FALSE, t, and TRUE.

Referenced by _render_preview_from_edit(), _save_and_render(), _textnotes_load_finish_idle(), _toggle_checklist_at_line(), and _toggle_mode().

_render_preview_from_edit()

static void _render_preview_from_edit ( dt_lib_textnotes_t *  d )

static

References _get_edit_text(), _render_preview(), d, and dt_free.

Referenced by _preview_map(), and _refresh_preview_idle().

_save_and_render()

static void _save_and_render ( dt_lib_module_t *  self )

static

References _ensure_has_txt_flag(), _get_edit_text(), _render_preview(), _update_mtime_label(), d, dt_lib_module_t::data, dt_control_log(), dt_free, error(), and FALSE.

Referenced by _save_now(), and _save_timeout_cb().

_save_now()

static void _save_now ( dt_lib_module_t *  self )

static

References _save_and_render(), d, and dt_lib_module_t::data.

Referenced by _completion_focus_out_idle(), _update_for_current_image(), and set_params().

_save_timeout_cb()

static gboolean _save_timeout_cb ( gpointer  user_data )

static

References _save_and_render(), d, and dt_lib_module_t::data.

Referenced by _textbuffer_changed().

_set_edit_text()

static void _set_edit_text ( dt_lib_textnotes_t *  d, const char *  text  )

static

References d, FALSE, and TRUE.

Referenced by _load_for_image(), _textnotes_load_finish_idle(), and set_params().

_set_image_paths()

static gboolean _set_image_paths ( dt_lib_textnotes_t *  d, const int32_t  imgid  )

static

References d, dt_free, dt_image_full_path(), FALSE, PATH_MAX, and TRUE.

Referenced by _expand_text_for_preview(), and _text_sidecar_save_path().

_setup_completion()

static void _setup_completion ( dt_lib_module_t *  self, GtkWidget *  textview  )

static

References _completion_row_activated(), COMPL_DESCRIPTION, d, dt_lib_module_t::data, and FALSE.

Referenced by gui_init().

_text_sidecar_save_path()

static char * _text_sidecar_save_path ( dt_lib_textnotes_t *  d, const int32_t  imgid  )

static

References _set_image_paths(), d, and dt_image_build_text_path_from_path().

Referenced by _load_for_image().

_textbuffer_changed()

static void _textbuffer_changed ( GtkTextBuffer *  buffer, dt_lib_module_t *  self  )

static

References _completion_update(), _save_timeout_cb(), d, dt_lib_module_t::data, and TRUE.

Referenced by gui_init().

_textnotes_load_finish_idle()

static gboolean _textnotes_load_finish_idle ( gpointer  user_data )

static

References _clear_mtime_label(), _ensure_has_txt_flag(), _render_preview(), _set_edit_text(), _toggle_mode(), _update_mtime_label(), cleanup(), d, dt_lib_module_t::data, dt_free, FALSE, dt_textnotes_load_result_t::loaded, dt_textnotes_load_result_t::self, dt_textnotes_load_result_t::text, dt_textnotes_load_result_t::token, and TRUE.

Referenced by _textnotes_load_job_state().

_textnotes_load_job_cleanup()

static void _textnotes_load_job_cleanup ( void *  data )

static

References dt_free.

Referenced by _load_for_image().

_textnotes_load_job_run()

static int32_t _textnotes_load_job_run ( dt_job_t *  job )

static

References dt_control_job_get_params(), and TRUE.

Referenced by _load_for_image().

_textnotes_load_job_state()

static void _textnotes_load_job_state ( dt_job_t *  job, dt_job_state_t  state  )

static

References _textnotes_load_finish_idle(), dt_control_job_get_params(), DT_JOB_STATE_FINISHED, dt_textnotes_load_result_t::loaded, dt_textnotes_load_result_t::self, dt_textnotes_load_result_t::text, and dt_textnotes_load_result_t::token.

Referenced by _load_for_image().

_textview_focus_out()

static gboolean _textview_focus_out ( GtkWidget *  widget, GdkEventFocus *  event, dt_lib_module_t *  self  )

static

References _completion_focus_out_idle(), d, dt_lib_module_t::data, FALSE, and void().

Referenced by gui_init().

_toggle_checklist_at_line()

static void _toggle_checklist_at_line ( dt_lib_module_t *  self, const int  line_no  )

static

References _get_buffer_text(), _render_preview(), _toggle_mode(), d, dt_lib_module_t::data, dt_free, FALSE, and TRUE.

Referenced by _preview_button_press().

_toggle_mode()

static void _toggle_mode ( GtkToggleButton *  button, dt_lib_module_t *  self  )

static

References _completion_hide(), _get_edit_text(), _render_preview(), d, dt_lib_module_t::data, and dt_free.

Referenced by _textnotes_load_finish_idle(), _toggle_checklist_at_line(), and gui_init().

_update_for_current_image()

static void _update_for_current_image ( dt_lib_module_t *  self )

static

References _load_for_image(), _save_now(), d, dt_lib_module_t::data, dt_act_on_get_first_image(), dt_control_get_mouse_over_id(), and dt_lib_gui_get_expanded().

Referenced by _edit_map(), _image_changed_callback(), _initial_load_idle(), _mouse_over_image_callback(), and gui_init().

_update_mtime_label()

static void _update_mtime_label ( dt_lib_module_t *  self )

static

References _clear_mtime_label(), _image_has_txt_flag(), d, dt_lib_module_t::data, dt_datetime_gdatetime_to_local(), dt_free, dt_lib_gui_get_expanded(), FALSE, and TRUE.

Referenced by _save_and_render(), and _textnotes_load_finish_idle().

container()

uint32_t container

(

dt_lib_module_t *

self

)

References DT_UI_CONTAINER_PANEL_LEFT_CENTER.

get_params()

void * get_params	(	dt_lib_module_t *	self,
		int *	size
	)

References _get_edit_text(), d, dt_lib_module_t::data, and size.

gui_cleanup()

void gui_cleanup

(

dt_lib_module_t *

self

)

References _clear_variables_cache(), _image_changed_callback(), _mouse_over_image_callback(), d, darktable, dt_lib_module_t::data, DT_DEBUG_CONTROL_SIGNAL_DISCONNECT, dt_free, and darktable_t::signals.

gui_init()

void gui_init

(

dt_lib_module_t *

self

)

References _edit_button_release(), _edit_key_press(), _edit_key_release(), _edit_map(), _image_changed_callback(), _initial_load_idle(), _mouse_over_image_callback(), _preview_button_press(), _preview_map(), _setup_completion(), _textbuffer_changed(), _textview_focus_out(), _toggle_mode(), _update_for_current_image(), d, darktable, dt_lib_module_t::data, dt_accels_disconnect_on_text_input(), DT_DEBUG_CONTROL_SIGNAL_CONNECT, DT_SIGNAL_DEVELOP_IMAGE_CHANGED, DT_SIGNAL_DEVELOP_INITIALIZE, DT_SIGNAL_MOUSE_OVER_IMAGE_CHANGE, dt_ui_scroll_wrap(), FALSE, darktable_t::signals, TRUE, and dt_lib_module_t::widget.

init_presets()

void init_presets

(

dt_lib_module_t *

self

)

References dt_lib_presets_add(), dt_lib_module_t::plugin_name, and TRUE.

name()

const char * name

(

dt_lib_module_t *

self

)

position()

int position

(

)

set_params()

int set_params	(	dt_lib_module_t *	self,
		const void *	params,
		int	size
	)

References _save_now(), _set_edit_text(), d, dt_lib_module_t::data, dt_free, size, and TRUE.

views()

const char ** views

(

dt_lib_module_t *

self

)

References v.