actionlist_t Struct Reference

Definition of an action. More...

#include <actions.h>

Data Fields
const char **	name
	Array of names this action will be called on the command line.
work_t *	work
	The function doing the setup, tear down, and in-between - the worker main function.
action_t *	repos_feedback
	The output function for repository accesses.
action_t *	local_callback
	The local callback.
action_uninit_t *	local_uninit
	The progress reporter needs a callback to clear the line after printing the progress.
char const *	help_text
	A pointer to the verbose help text.
int	i_val
	Flag for usage in the action handler itself.
int	is_import_export:1
	Is this an import or export, ie do we need a WAA? We don't cache properties, manber-hashes, etc., if is_import_export is set.
int	is_compare:1
	This is set if it's a compare operation (remote-status).
int	needs_decoder:1
	Whether we need fsvs:update-pipe cached.
int	only_opt_filter:1
	Whether the entries should be filtered on opt_filter.
int	keep_user_prop:1
	Whether user properties should be stored in estat::user_prop while running cb__record_changes().
int	keep_children:1
	Makes ops__update_single_entry() keep the children of removed directories.
int	overwrite_sts_st:1
	Says that we want the `estat::st` overwritten while looking for local changes.
int	do_update_dir:1
	Whether waa__update_dir() may happen.
int	is_readonly:1
	Says that this is a read-only operation (like "status").

Detailed Description

Definition of an action.

Definition at line 59 of file actions.h.

Field Documentation

int actionlist_t::do_update_dir

Whether waa__update_dir() may happen.

(It must not for updates, as we'd store local changes as "from repository").

Definition at line 128 of file actions.h.

Referenced by waa___check_dir_for_update().

char const* actionlist_t::help_text

A pointer to the verbose help text.

Definition at line 95 of file actions.h.

Referenced by ac__Usage().

int actionlist_t::i_val

Flag for usage in the action handler itself.

Definition at line 98 of file actions.h.

Referenced by au__action(), ign__work(), and prp__s_work().

int actionlist_t::is_compare

This is set if it's a compare operation (remote-status).

The properties are parsed, but instead of writing them into the struct estat they are compared, and entry_status set accordingly.

Definition at line 108 of file actions.h.

Referenced by up__add_directory(), up__apply_textdelta(), up__close_file(), up__parse_prop(), and up__work().

int actionlist_t::is_import_export

Is this an import or export, ie do we need a WAA? We don't cache properties, manber-hashes, etc., if is_import_export is set.

Definition at line 103 of file actions.h.

Referenced by up__apply_textdelta(), and waa__init().

int actionlist_t::is_readonly

Says that this is a read-only operation (like "status").

Definition at line 130 of file actions.h.

Referenced by waa__init(), and waa__open().

int actionlist_t::keep_children

Makes ops__update_single_entry() keep the children of removed directories.

Definition at line 121 of file actions.h.

Referenced by waa__update_tree().

int actionlist_t::keep_user_prop

Whether user properties should be stored in estat::user_prop while running cb__record_changes().

Definition at line 118 of file actions.h.

Referenced by cb___store_prop().

action_t* actionlist_t::local_callback

The local callback.

Called for each entry, just after it's been checked for changes. Should give the user feedback about individual entries and what happens with them.

For directories this gets called when they're finished; so immediately for empty directories, or after all children are loaded.

Note:: A removed directory is taken as empty (as no more elements are here) - this is used in revert so that revert gets called twice (once for restoring the directory itself, and again after its populated).

See callbacks.

Definition at line 89 of file actions.h.

Referenced by ac__dispatch(), df__work(), ign__work(), rev__work(), and st__work().