mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-03 17:57:25 +00:00
77 lines
2.4 KiB
C
77 lines
2.4 KiB
C
/*
|
|
* 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_revparse_h__
|
|
#define INCLUDE_git_revparse_h__
|
|
|
|
#include "common.h"
|
|
#include "types.h"
|
|
|
|
|
|
/**
|
|
* @file git2/revparse.h
|
|
* @brief Git revision parsing routines
|
|
* @defgroup git_revparse Git revision parsing routines
|
|
* @ingroup Git
|
|
* @{
|
|
*/
|
|
GIT_BEGIN_DECL
|
|
|
|
/**
|
|
* Find a single object, as specified by a revision string. See `man gitrevisions`,
|
|
* or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for
|
|
* information on the syntax accepted.
|
|
*
|
|
* @param out pointer to output object
|
|
* @param repo the repository to search in
|
|
* @param spec the textual specification for an object
|
|
* @return 0 on success, GIT_ENOTFOUND, GIT_EAMBIGUOUS, GIT_EINVALIDSPEC or an error code
|
|
*/
|
|
GIT_EXTERN(int) git_revparse_single(git_object **out, git_repository *repo, const char *spec);
|
|
|
|
|
|
/**
|
|
* Revparse flags. These indicate the intended behavior of the spec passed to
|
|
* git_revparse.
|
|
*/
|
|
typedef enum {
|
|
/** The spec targeted a single object. */
|
|
GIT_REVPARSE_SINGLE = 1 << 0,
|
|
/** The spec targeted a range of commits. */
|
|
GIT_REVPARSE_RANGE = 1 << 1,
|
|
/** The spec used the '...' operator, which invokes special semantics. */
|
|
GIT_REVPARSE_MERGE_BASE = 1 << 2,
|
|
} git_revparse_flag_t;
|
|
|
|
|
|
/**
|
|
* Parse a revision string for left, right, and intent. See `man gitrevisions` or
|
|
* http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information
|
|
* on the syntax accepted.
|
|
*
|
|
* @param left buffer that receives the target of the left side of a range operator. If
|
|
* there is no range operator, this buffer receives the single target.
|
|
* @param right buffer that receives the target of the right side of a range operator.
|
|
* This is only filled in if `spec` specifies a range of commits. May
|
|
* be NULL.
|
|
* @param flags buffer that receives a bitwise combination of `git_revparse_flag_t` values.
|
|
* May be NULL.
|
|
* @param repo the repository to search in
|
|
* @param spec the rev-parse spec to parse
|
|
* @return 0 on success, GIT_INVALIDSPEC, GIT_ENOTFOUND, GIT_EAMBIGUOUS or an error code
|
|
*/
|
|
GIT_EXTERN(int) git_revparse(
|
|
git_object **left,
|
|
git_object **right,
|
|
unsigned int *flags,
|
|
git_repository *repo,
|
|
const char *spec);
|
|
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
#endif
|