/*
 * 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.
 */
/**
 * License: GPL-2.0(Linking Exception)
 */
module libgit2.describe;


private static import libgit2.buffer;
private static import libgit2.types;
private import libgit2.common: GIT_EXTERN;

/*
 * @file git2/describe.h
 * @brief Git describing routines
 * @defgroup git_describe Git describing routines
 * @ingroup Git
 * @{
 */
extern (C):
nothrow @nogc:
public:

/**
 * Reference lookup strategy
 *
 * These behave like the --tags and --all options to git-describe,
 * namely they say to look for any reference in either refs/tags/ or
 * refs/ respectively.
 */
enum git_describe_strategy_t
{
	GIT_DESCRIBE_DEFAULT,
	GIT_DESCRIBE_TAGS,
	GIT_DESCRIBE_ALL,
}

//Declaration name in C language
enum
{
	GIT_DESCRIBE_DEFAULT = .git_describe_strategy_t.GIT_DESCRIBE_DEFAULT,
	GIT_DESCRIBE_TAGS = .git_describe_strategy_t.GIT_DESCRIBE_TAGS,
	GIT_DESCRIBE_ALL = .git_describe_strategy_t.GIT_DESCRIBE_ALL,
}

/**
 * Describe options structure
 *
 * Initialize with `GIT_DESCRIBE_OPTIONS_INIT`. Alternatively, you can
 * use `git_describe_options_init`.
 */
struct git_describe_options
{
	uint version_;

	/**
	 * default: 10
	 */
	uint max_candidates_tags;

	/**
	 * default: git_describe_strategy_t.GIT_DESCRIBE_DEFAULT
	 */
	uint describe_strategy;

	const (char)* pattern;

	/**
	 * When calculating the distance from the matching tag or
	 * reference, only walk down the first-parent ancestry.
	 */
	int only_follow_first_parent;

	/**
	 * If no matching tag or reference is found, the describe
	 * operation would normally fail. If this option is set, it
	 * will instead fall back to showing the full id of the
	 * commit.
	 */
	int show_commit_oid_as_fallback;
}

enum GIT_DESCRIBE_DEFAULT_MAX_CANDIDATES_TAGS = 10;
enum GIT_DESCRIBE_DEFAULT_ABBREVIATED_SIZE = 7;

enum GIT_DESCRIBE_OPTIONS_VERSION = 1;

pragma(inline, true)
pure nothrow @safe @nogc @live
.git_describe_options GIT_DESCRIBE_OPTIONS_INIT()

	do
	{
		.git_describe_options OUTPUT =
		{
			version_: .GIT_DESCRIBE_OPTIONS_VERSION,
			max_candidates_tags: .GIT_DESCRIBE_DEFAULT_MAX_CANDIDATES_TAGS,
		};

		return OUTPUT;
	}

/**
 * Initialize git_describe_options structure
 *
 * Initializes a `git_describe_options` with default values. Equivalent to creating
 * an instance with GIT_DESCRIBE_OPTIONS_INIT.
 *
 * Params:
 *      opts = The `git_describe_options` struct to initialize.
 *      version_ = The struct version; pass `GIT_DESCRIBE_OPTIONS_VERSION`.
 *
 * Returns: Zero on success; -1 on failure.
 */
@GIT_EXTERN
int git_describe_options_init(.git_describe_options* opts, uint version_);

/**
 * Describe format options structure
 *
 * Initialize with `GIT_DESCRIBE_FORMAT_OPTIONS_INIT`. Alternatively, you can
 * use `git_describe_format_options_init`.
 */
struct git_describe_format_options
{
	uint version_;

	/**
	 * Size of the abbreviated commit id to use. This value is the
	 * lower bound for the length of the abbreviated string. The
	 * default is 7.
	 */
	uint abbreviated_size;

	/**
	 * Set to use the long format even when a shorter name could be used.
	 */
	int always_use_long_format;

	/**
	 * If the workdir is dirty and this is set, this string will
	 * be appended to the description string.
	 */
	const (char)* dirty_suffix;
}

enum GIT_DESCRIBE_FORMAT_OPTIONS_VERSION = 1;

pragma(inline, true)
pure nothrow @safe @nogc @live
.git_describe_format_options GIT_DESCRIBE_FORMAT_OPTIONS_INIT()

	do
	{
		.git_describe_format_options OUTPUT =
		{
			version_: .GIT_DESCRIBE_FORMAT_OPTIONS_VERSION,
			abbreviated_size: .GIT_DESCRIBE_DEFAULT_ABBREVIATED_SIZE,
		};

		return OUTPUT;
	}

/**
 * Initialize git_describe_format_options structure
 *
 * Initializes a `git_describe_format_options` with default values. Equivalent to creating
 * an instance with GIT_DESCRIBE_FORMAT_OPTIONS_INIT.
 *
 * Params:
 *      opts = The `git_describe_format_options` struct to initialize.
 *      version_ = The struct version; pass `GIT_DESCRIBE_FORMAT_OPTIONS_VERSION`.
 *
 * Returns: Zero on success; -1 on failure.
 */
@GIT_EXTERN
int git_describe_format_options_init(.git_describe_format_options* opts, uint version_);

/**
 * A struct that stores the result of a describe operation.
 */
struct git_describe_result;

/**
 * Describe a commit
 *
 * Perform the describe operation on the given committish object.
 *
 * Params:
 *      result = pointer to store the result. You must free this once you're done with it.
 *      committish = a committish to describe
 *      opts = the lookup options (or null for defaults)
 *
 * Returns: 0 or an error code.
 */
@GIT_EXTERN
int git_describe_commit(.git_describe_result** result, libgit2.types.git_object* committish, .git_describe_options* opts);

/**
 * Describe a commit
 *
 * Perform the describe operation on the current commit and the
 * worktree. After performing describe on HEAD, a status is run and the
 * description is considered to be dirty if there are.
 *
 * Params:
 *      out_ = pointer to store the result. You must free this once you're done with it.
 *      repo = the repository in which to perform the describe
 *      opts = the lookup options (or null for defaults)
 *
 * Returns: 0 or an error code.
 */
@GIT_EXTERN
int git_describe_workdir(.git_describe_result** out_, libgit2.types.git_repository* repo, .git_describe_options* opts);

/**
 * Print the describe result to a buffer
 *
 * Params:
 *      out_ = The buffer to store the result
 *      result = the result from `git_describe_commit()` or `git_describe_workdir()`.
 *      opts = the formatting options (or null for defaults)
 *
 * Returns: 0 or an error code.
 */
@GIT_EXTERN
int git_describe_format(libgit2.buffer.git_buf* out_, const (.git_describe_result)* result, const (.git_describe_format_options)* opts);

/**
 * Free the describe result.
 *
 * Params:
 *      result = The result to free.
 */
@GIT_EXTERN
void git_describe_result_free(.git_describe_result* result);

/* @} */