progress.h File Reference

#include <glib.h>

Include dependency graph for progress.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct _dt_progress_t	dt_progress_t
typedef void(*	dt_progress_cancel_callback_t) (dt_progress_t *progress, void *data)

Functions
void	dt_control_progress_init (struct dt_control_t *control)
dt_progress_t *	dt_control_progress_create (struct dt_control_t *control, gboolean has_progress_bar, const gchar *message)
void	dt_control_progress_destroy (struct dt_control_t *control, dt_progress_t *progress)
void	dt_control_progress_make_cancellable (struct dt_control_t *control, dt_progress_t *progress, dt_progress_cancel_callback_t cancel, void *data)
void	dt_control_progress_attach_job (struct dt_control_t *control, dt_progress_t *progress, struct _dt_job_t *job)
void	dt_control_progress_cancel (struct dt_control_t *control, dt_progress_t *progress)
void	dt_control_progress_set_progress (struct dt_control_t *control, dt_progress_t *progress, double value)
double	dt_control_progress_get_progress (dt_progress_t *progress)
const gchar *	dt_control_progress_get_message (dt_progress_t *progress)
void	dt_control_progress_set_message (struct dt_control_t *control, dt_progress_t *progress, const char *message)
void	dt_control_progress_set_gui_data (dt_progress_t *progress, void *data)
void *	dt_control_progress_get_gui_data (dt_progress_t *progress)
gboolean	dt_control_progress_has_progress_bar (dt_progress_t *progress)
gboolean	dt_control_progress_cancellable (dt_progress_t *progress)

Typedef Documentation

dt_progress_cancel_callback_t

typedef void(* dt_progress_cancel_callback_t) (dt_progress_t *progress, void *data)

dt_progress_t

typedef struct _dt_progress_t dt_progress_t

Function Documentation

dt_control_progress_attach_job()

void dt_control_progress_attach_job	(	struct dt_control_t *	control,
		dt_progress_t *	progress,
		struct _dt_job_t *	job
	)

convenience function to cancel a job when the progress gets cancelled.

References dt_control_progress_cancel_callback(), and dt_control_progress_make_cancellable().

Referenced by dt_control_job_add_progress().

dt_control_progress_cancel()

void dt_control_progress_cancel	(	struct dt_control_t *	control,
		dt_progress_t *	progress
	)

cancel the job linked to with dt_control_progress_attach_job(). don't forget to call dt_control_progress_destroy() afterwards.

References _dt_progress_t::cancel, _dt_progress_t::cancel_data, dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), and _dt_progress_t::mutex.

Referenced by _lib_backgroundjobs_cancel_callback_new().

dt_control_progress_cancellable()

gboolean dt_control_progress_cancellable

(

dt_progress_t *

progress

)

has a job been linked to the progress object?

References _dt_progress_t::cancel, dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), and _dt_progress_t::mutex.

Referenced by gui_init().

dt_control_progress_create()

dt_progress_t * dt_control_progress_create	(	struct dt_control_t *	control,
		gboolean	has_progress_bar,
		const gchar *	message
	)

create a new progress object and add it to the gui. pass it to dt_control_progress_destroy() to free the resources.

References dt_control_t::added, dt_pthread_mutex_init(), dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), global_progress_start(), _dt_progress_t::gui_data, _dt_progress_t::has_progress_bar, dt_control_t::list, dt_control_t::list_length, _dt_progress_t::message, dt_control_t::mutex, _dt_progress_t::mutex, dt_control_t::progress_system, and dt_control_t::proxy.

Referenced by _lua_create_job(), and dt_control_job_add_progress().

dt_control_progress_destroy()

void dt_control_progress_destroy	(	struct dt_control_t *	control,
		dt_progress_t *	progress
	)

free the resources and remove the gui.

References dt_control_t::destroyed, dt_pthread_mutex_destroy(), dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), global_progress_end(), _dt_progress_t::gui_data, _dt_progress_t::has_progress_bar, dt_control_t::list, dt_control_t::list_length, _dt_progress_t::message, dt_control_t::mutex, _dt_progress_t::mutex, dt_control_t::progress_system, and dt_control_t::proxy.

Referenced by _lua_job_valid(), dt_control_job_dispose(), and dt_control_job_set_state().

dt_control_progress_get_gui_data()

void * dt_control_progress_get_gui_data

(

dt_progress_t *

progress

)

References dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), _dt_progress_t::gui_data, and _dt_progress_t::mutex.

Referenced by gui_init().

dt_control_progress_get_message()

const gchar * dt_control_progress_get_message

(

dt_progress_t *

progress

)

get the message passed during construction.

References dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), _dt_progress_t::message, and _dt_progress_t::mutex.

Referenced by gui_init().

dt_control_progress_get_progress()

double dt_control_progress_get_progress

(

dt_progress_t *

progress

)

return the last set progress value.

References dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), _dt_progress_t::mutex, and _dt_progress_t::progress.

Referenced by _lua_job_progress(), dt_control_job_get_progress(), global_progress_end(), and gui_init().

dt_control_progress_has_progress_bar()

gboolean dt_control_progress_has_progress_bar

(

dt_progress_t *

progress

)

does the progress object have a progress bar in its gui?

References dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), _dt_progress_t::has_progress_bar, and _dt_progress_t::mutex.

Referenced by _lua_job_progress(), and gui_init().

dt_control_progress_init()

void dt_control_progress_init

(

struct dt_control_t *

control

)

References darktable, darktable_t::dbus, dt_dbus_t::dbus_connection, error(), and FALSE.

Referenced by dt_init().

dt_control_progress_make_cancellable()

void dt_control_progress_make_cancellable	(	struct dt_control_t *	control,
		dt_progress_t *	progress,
		dt_progress_cancel_callback_t	cancel,
		void *	data
	)

set a callback to be executed when the progress is being cancelled.

References _dt_progress_t::cancel, _dt_progress_t::cancel_data, dt_control_t::cancellable, dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), _dt_progress_t::gui_data, dt_control_t::mutex, _dt_progress_t::mutex, dt_control_t::progress_system, and dt_control_t::proxy.

Referenced by _lua_create_job(), and dt_control_progress_attach_job().

dt_control_progress_set_gui_data()

void dt_control_progress_set_gui_data	(	dt_progress_t *	progress,
		void *	data
	)

these functions are to be used by lib/backgroundjobs.c only.

References dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), _dt_progress_t::gui_data, and _dt_progress_t::mutex.

Referenced by gui_init().

dt_control_progress_set_message()

void dt_control_progress_set_message	(	struct dt_control_t *	control,
		dt_progress_t *	progress,
		const char *	message
	)

update the message.

References dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), _dt_progress_t::gui_data, _dt_progress_t::message, dt_control_t::message_updated, dt_control_t::mutex, _dt_progress_t::mutex, dt_control_t::progress_system, and dt_control_t::proxy.

Referenced by dt_control_job_set_progress_message().

dt_control_progress_set_progress()

void dt_control_progress_set_progress	(	struct dt_control_t *	control,
		dt_progress_t *	progress,
		double	value
	)

update the progress of the progress object. the range should be [0.0, 1.0] to make progress bars work.

References dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), global_progress_set(), _dt_progress_t::gui_data, _dt_progress_t::has_progress_bar, dt_control_t::mutex, _dt_progress_t::mutex, _dt_progress_t::progress, dt_control_t::progress_system, dt_control_t::proxy, and dt_control_t::updated.

Referenced by _lua_job_progress(), and dt_control_job_set_progress().