#ifndef VIFM_TESTS__TEST_SUPPORT__TEST_UTILS_H__
#define VIFM_TESTS__TEST_SUPPORT__TEST_UTILS_H__

#include <stddef.h> /* size_t */

/* Executable suffixes. */
#if defined(__CYGWIN__) || defined(_WIN32)
#define EXE_SUFFIX ".exe"
#define EXE_SUFFIXW L".exe"
#else
#define EXE_SUFFIX ""
#define EXE_SUFFIXW L""
#endif

#ifdef _WIN32
#define SL "\\\\"
#else
#define SL "/"
#endif

struct bg_job_t;
struct view_t;

/* _wenviron used on Windows gets created only if we invoke __wgetmainargs(), so
 * do it here. */
void fix_environ(void);

/* Prepares configuration for use in tests. */
void conf_setup(void);

/* Cleans up configuration. */
void conf_teardown(void);

/* Prepares option handler for use in tests. */
void opt_handlers_setup(void);

/* Cleans up option handlers. */
void opt_handlers_teardown(void);

/* Prepares undo unit for file operations. */
void undo_setup(void);

/* Cleans up undo unit. */
void undo_teardown(void);

/* Initializes view with safe defaults. */
void view_setup(struct view_t *view);

/* Frees resources of the view. */
void view_teardown(struct view_t *view);

/* Sets up sorting with up to 2 sorting keys (use SK_NONE for unused ones). */
void view_set_sort(signed char sort_keys[], signed char primary_key,
		signed char secondary_key);

/* Registers a column with specified id that prints empty string. */
void columns_setup_column(int id);

/* Unregisters all columns and resets print function. */
void columns_teardown(void);

/* Initializes engine/cmds unit. */
void engine_cmds_setup(int real_completion);

/* Uninitializes engine/cmds unit. */
void engine_cmds_teardown(void);

/* Initializes empty histories of specified size. */
void histories_init(int size);

/* Creates empty directory at specified path. */
void create_dir(const char path[]);

/* Creates file at the path. */
void create_file(const char path[]);

/* Creates executable file at the path. */
void create_executable(const char path[]);

/* Makes a file with specified contents. */
void make_file(const char path[], const char contents[]);

/* Makes a symbolic link.  Returns zero on success, otherwise non-zero is
 * returned.  */
int make_symlink(const char target[], const char linkpath[]);

/* Removes empty directory at specified path. */
void remove_dir(const char path[]);

/* Removes empty directory at specified path checking that the removal fails. */
void no_remove_dir(const char path[]);

/* Removes file at specified path. */
void remove_file(const char path[]);

/* Removes empty file at specified path checking that the removal fails. */
void no_remove_file(const char path[]);

/* Either puts base/sub or cwd/base/sub into the buf.  If cwd is NULL, current
 * working directory is used. */
void make_abs_path(char buf[], size_t buf_len, const char base[],
		const char sub[], const char cwd[]);

/* Copies file at src to dst. */
void copy_file(const char src[], const char dst[]);

/* Whether running on Windows.  Returns non-zero if so, otherwise zero is
 * returned. */
int windows(void);

/* Whether running on non-Windows.  Returns non-zero if so, otherwise zero is
 * returned. */
int not_windows(void);

/* Whether running outside of WINE.  Returns non-zero if so, otherwise zero is
 * returned. */
int not_wine(void);

/* Attempts to switch to UTF-8 capable locale.  Use utf8_locale() to check if
 * successful. */
void try_enable_utf8_locale(void);

/* Whether locale is UTF-8.  Returns non-zero if so, otherwise zero is
 * returned. */
int utf8_locale(void);

/* Whether running as a regular user under Unix and can therefore force
 * errors via chmod().  Returns non-zero if so, otherwise zero is returned. */
int regular_unix_user(void);

/* Whether cat program is available somewhere in the $PATH.  Returns non-zero if
 * so, otherwise zero is returned. */
int have_cat(void);

struct matcher_t;

/* Changes *matcher to have the value of the expr.  The operation is assumed to
 * succeed, but it's not guaranteed. */
int replace_matcher(struct matcher_t **matcher, const char expr[]);

struct view_t;

/* Setups a grid of specified dimensions for the view. */
void setup_grid(struct view_t *view, int column_count, int list_rows, int init);

/* Setups transposed grid of specified dimensions for the view. */
void setup_transposed_grid(struct view_t *view, int column_count, int list_rows,
		int init);

/* Loads dummy list of files into a view.  It consists of a single fake
 * entry. */
void init_view_list(struct view_t *view);

/* Checks state of two-pane compare for sanity. */
void check_compare_invariants(int expected_len);

/* Checks currently running background tasks. */
void check_bg_jobs(void);

/* Waits termination of all background tasks. */
void wait_for_bg(void);

/* Waits termination of all background jobs including external applications. */
void wait_for_all_bg(void);

/* Waits termination of a particular task.  Returns job's exit code or -1 on
 * error. */
int wait_for_job(struct bg_job_t *job);

/* Verifies that file at specified path consists of specified list of lines. */
void file_is(const char path[], const char *lines[], int nlines);

/* Replaces value of an environment variable.  Pass returned value to
 * unmock_env() to restore its state.  Returns its old value. */
char * mock_env(const char env[], const char with[]);

/* Restores value of an environment variable changed by mock_env(). */
void unmock_env(const char env[], char old_value[]);

/* Initializes color manager with functions that do nothing. */
void stub_colmgr(void);

/* Changes time attributes of a file to something "long time ago". */
void reset_timestamp(const char path[]);

struct plugs_t;

/* Appends "/plugins" to the passed in directory and loads plugins from
 * there. */
void load_plugins(struct plugs_t *plugs, const char cfg_dir[]);

#endif /* VIFM_TESTS__TEST_SUPPORT__TEST_UTILS_H__ */

/* vim: set tabstop=2 softtabstop=2 shiftwidth=2 noexpandtab cinoptions-=(0 : */
/* vim: set cinoptions+=t0 filetype=c : */
