/*

 * Copyright (C) the libgit2 contributors. All rights reserved.

 *

 * This file is part of libgit2, distributed under the GNU GPL v2 with

 * a Linking Exception. For full terms see the included COPYING file.

 */

#ifndef INCLUDE_git_stash_h__

#define INCLUDE_git_stash_h__

#include "common.h"

#include "types.h"

/**

 * @file git2/stash.h

 * @brief Git stash management routines

 * @ingroup Git

 * @{

 */

GIT_BEGIN_DECL

/**

 * Stash flags

 */

typedef enum {

	/**

	 * No option, default

	 */

	GIT_STASH_DEFAULT = 0,

	/**

	 * All changes already added to the index are left intact in

	 * the working directory

	 */

	GIT_STASH_KEEP_INDEX = (1 << 0),

	/**

	 * All untracked files are also stashed and then cleaned up

	 * from the working directory

	 */

	GIT_STASH_INCLUDE_UNTRACKED = (1 << 1),

	/**

	 * All ignored files are also stashed and then cleaned up from

	 * the working directory

	 */

	GIT_STASH_INCLUDE_IGNORED = (1 << 2),

} git_stash_flags;

/**

 * Save the local modifications to a new stash.

 *

 * @param out Object id of the commit containing the stashed state.

 * This commit is also the target of the direct reference refs/stash.

 *

 * @param repo The owning repository.

 *

 * @param stasher The identity of the person performing the stashing.

 *

 * @param message Optional description along with the stashed state.

 *

 * @param flags Flags to control the stashing process. (see GIT_STASH_* above)

 *

 * @return 0 on success, GIT_ENOTFOUND where there's nothing to stash,

 * or error code.

 */

GIT_EXTERN(int) git_stash_save(

	git_oid *out,

	git_repository *repo,

	const git_signature *stasher,

	const char *message,

	uint32_t flags);

/** Stash application flags. */

typedef enum {

	GIT_STASH_APPLY_DEFAULT = 0,

	/* Try to reinstate not only the working tree's changes,

	 * but also the index's changes.

	 */

	GIT_STASH_APPLY_REINSTATE_INDEX = (1 << 0),

} git_stash_apply_flags;

typedef enum {

	GIT_STASH_APPLY_PROGRESS_NONE = 0,

	/** Loading the stashed data from the object database. */

	GIT_STASH_APPLY_PROGRESS_LOADING_STASH,

	/** The stored index is being analyzed. */

	GIT_STASH_APPLY_PROGRESS_ANALYZE_INDEX,

	/** The modified files are being analyzed. */

	GIT_STASH_APPLY_PROGRESS_ANALYZE_MODIFIED,

	/** The untracked and ignored files are being analyzed. */

	GIT_STASH_APPLY_PROGRESS_ANALYZE_UNTRACKED,

	/** The untracked files are being written to disk. */

	GIT_STASH_APPLY_PROGRESS_CHECKOUT_UNTRACKED,

	/** The modified files are being written to disk. */

	GIT_STASH_APPLY_PROGRESS_CHECKOUT_MODIFIED,

	/** The stash was applied successfully. */

	GIT_STASH_APPLY_PROGRESS_DONE,

} git_stash_apply_progress_t;

/**

 * Stash application progress notification function.

 * Return 0 to continue processing, or a negative value to

 * abort the stash application.

 */

typedef int (*git_stash_apply_progress_cb)(

	git_stash_apply_progress_t progress,

	void *payload);

/** Stash application options structure.

 *

 * Initialize with the `GIT_STASH_APPLY_OPTIONS_INIT` macro to set

 * sensible defaults; for example:

 *

 *		git_stash_apply_options opts = GIT_STASH_APPLY_OPTIONS_INIT;

 */

typedef struct git_stash_apply_options {

	unsigned int version;

	/** See `git_stash_apply_flags_t`, above. */

	git_stash_apply_flags flags;

	/** Options to use when writing files to the working directory. */

	git_checkout_options checkout_options;

	/** Optional callback to notify the consumer of application progress. */

	git_stash_apply_progress_cb progress_cb;

	void *progress_payload;

} git_stash_apply_options;

#define GIT_STASH_APPLY_OPTIONS_VERSION 1

#define GIT_STASH_APPLY_OPTIONS_INIT { \

	GIT_STASH_APPLY_OPTIONS_VERSION, \

	GIT_STASH_APPLY_DEFAULT, \

	GIT_CHECKOUT_OPTIONS_INIT }

/**

 * Initializes a `git_stash_apply_options` with default values. Equivalent to

 * creating an instance with GIT_STASH_APPLY_OPTIONS_INIT.

 *

 * @param opts the `git_stash_apply_options` instance to initialize.

 * @param version the version of the struct; you should pass

 *        `GIT_STASH_APPLY_OPTIONS_INIT` here.

 * @return Zero on success; -1 on failure.

 */

GIT_EXTERN(int) git_stash_apply_init_options(

	git_stash_apply_options *opts, unsigned int version);

/**

 * Apply a single stashed state from the stash list.

 *

 * If local changes in the working directory conflict with changes in the

 * stash then GIT_EMERGECONFLICT will be returned.  In this case, the index

 * will always remain unmodified and all files in the working directory will

 * remain unmodified.  However, if you are restoring untracked files or

 * ignored files and there is a conflict when applying the modified files,

 * then those files will remain in the working directory.

 *

 * If passing the GIT_STASH_APPLY_REINSTATE_INDEX flag and there would be

 * conflicts when reinstating the index, the function will return

 * GIT_EMERGECONFLICT and both the working directory and index will be left

 * unmodified.

 *

 * Note that a minimum checkout strategy of `GIT_CHECKOUT_SAFE` is implied.

 *

 * @param repo The owning repository.

 * @param index The position within the stash list. 0 points to the

 *              most recent stashed state.

 * @param options Optional options to control how stashes are applied.

 *

 * @return 0 on success, GIT_ENOTFOUND if there's no stashed state for the

 *         given index, GIT_EMERGECONFLICT if changes exist in the working

 *         directory, or an error code

 */

GIT_EXTERN(int) git_stash_apply(

	git_repository *repo,

	size_t index,

	const git_stash_apply_options *options);

/**

 * This is a callback function you can provide to iterate over all the

 * stashed states that will be invoked per entry.

 *

 * @param index The position within the stash list. 0 points to the

 *              most recent stashed state.

 * @param message The stash message.

 * @param stash_id The commit oid of the stashed state.

 * @param payload Extra parameter to callback function.

 * @return 0 to continue iterating or non-zero to stop.

 */

typedef int (*git_stash_cb)(

	size_t index,

	const char* message,

	const git_oid *stash_id,

	void *payload);

/**

 * Loop over all the stashed states and issue a callback for each one.

 *

 * If the callback returns a non-zero value, this will stop looping.

 *

 * @param repo Repository where to find the stash.

 *

 * @param callback Callback to invoke per found stashed state. The most

 *                 recent stash state will be enumerated first.

 *

 * @param payload Extra parameter to callback function.

 *

 * @return 0 on success, non-zero callback return value, or error code.

 */

GIT_EXTERN(int) git_stash_foreach(

	git_repository *repo,

	git_stash_cb callback,

	void *payload);

/**

 * Remove a single stashed state from the stash list.

 *

 * @param repo The owning repository.

 *

 * @param index The position within the stash list. 0 points to the

 * most recent stashed state.

 *

 * @return 0 on success, GIT_ENOTFOUND if there's no stashed state for the given

 * index, or error code.

 */

GIT_EXTERN(int) git_stash_drop(

	git_repository *repo,

	size_t index);

/**

 * Apply a single stashed state from the stash list and remove it from the list

 * if successful.

 *

 * @param repo The owning repository.

 * @param index The position within the stash list. 0 points to the

 *              most recent stashed state.

 * @param options Optional options to control how stashes are applied.

 *

 * @return 0 on success, GIT_ENOTFOUND if there's no stashed state for the given

 * index, or error code. (see git_stash_apply() above for details)

*/

GIT_EXTERN(int) git_stash_pop(

	git_repository *repo,

	size_t index,

	const git_stash_apply_options *options);

/** @} */

GIT_END_DECL

#endif