diff --git a/include/git2/refs.h b/include/git2/refs.h index 468d0f930..56e8c6c38 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -525,6 +525,21 @@ GIT_EXTERN(int) git_reference_peel( */ GIT_EXTERN(int) git_reference_is_valid_name(const char *refname); +/** + * Get the reference's short name + * + * This will transform the reference name into a name "human-readable" + * version. If no shortname is appropriate, it will return the full + * name. + * + * The memory is owned by the reference and must not be freed. + * + * @param ref a reference + * @return the human-readable version of the name + */ +GIT_EXTERN(const char *) git_reference_shorthand(git_reference *ref); + + /** @} */ GIT_END_DECL #endif diff --git a/src/refs.c b/src/refs.c index 9c6c5c623..166669ef2 100644 --- a/src/refs.c +++ b/src/refs.c @@ -1131,3 +1131,20 @@ int git_reference_is_valid_name( refname, GIT_REF_FORMAT_ALLOW_ONELEVEL); } + +const char *git_reference_shorthand(git_reference *ref) +{ + const char *name = ref->name; + + if (!git__prefixcmp(name, GIT_REFS_HEADS_DIR)) + return name + strlen(GIT_REFS_HEADS_DIR); + else if (!git__prefixcmp(name, GIT_REFS_TAGS_DIR)) + return name + strlen(GIT_REFS_TAGS_DIR); + else if (!git__prefixcmp(name, GIT_REFS_REMOTES_DIR)) + return name + strlen(GIT_REFS_REMOTES_DIR); + else if (!git__prefixcmp(name, GIT_REFS_DIR)) + return name + strlen(GIT_REFS_DIR); + + /* No shorthands are avaiable, so just return the name */ + return name; +} diff --git a/tests-clar/refs/shorthand.c b/tests-clar/refs/shorthand.c new file mode 100644 index 000000000..f995d26ca --- /dev/null +++ b/tests-clar/refs/shorthand.c @@ -0,0 +1,27 @@ +#include "clar_libgit2.h" + +#include "repository.h" + +void assert_shorthand(git_repository *repo, const char *refname, const char *shorthand) +{ + git_reference *ref; + + cl_git_pass(git_reference_lookup(&ref, repo, refname)); + cl_assert_equal_s(git_reference_shorthand(ref), shorthand); + git_reference_free(ref); +} + +void test_refs_shorthand__0(void) +{ + git_repository *repo; + + cl_git_pass(git_repository_open(&repo, cl_fixture("testrepo.git"))); + + + assert_shorthand(repo, "refs/heads/master", "master"); + assert_shorthand(repo, "refs/tags/test", "test"); + assert_shorthand(repo, "refs/remotes/test/master", "test/master"); + assert_shorthand(repo, "refs/notes/fanout", "notes/fanout"); + + git_repository_free(repo); +}