refs.h 3.42 KB
Newer Older
Vicent Marti committed
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
Vicent Marti committed
3 4 5 6
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
7 8 9 10 11
#ifndef INCLUDE_refs_h__
#define INCLUDE_refs_h__

#include "common.h"
#include "git2/oid.h"
12
#include "git2/refs.h"
13
#include "git2/refdb.h"
14
#include "strmap.h"
15
#include "buffer.h"
16
#include "oid.h"
17 18 19 20

#define GIT_REFS_DIR "refs/"
#define GIT_REFS_HEADS_DIR GIT_REFS_DIR "heads/"
#define GIT_REFS_TAGS_DIR GIT_REFS_DIR "tags/"
21
#define GIT_REFS_REMOTES_DIR GIT_REFS_DIR "remotes/"
22
#define GIT_REFS_DIR_MODE 0777
23
#define GIT_REFS_FILE_MODE 0666
24

25 26
#define GIT_RENAMED_REF_FILE GIT_REFS_DIR "RENAMED-REF"

27
#define GIT_SYMREF "ref: "
28
#define GIT_PACKEDREFS_FILE "packed-refs"
29
#define GIT_PACKEDREFS_HEADER "# pack-refs with: peeled fully-peeled "
30
#define GIT_PACKEDREFS_FILE_MODE 0666
31

32
#define GIT_HEAD_FILE "HEAD"
Edward Thomson committed
33
#define GIT_ORIG_HEAD_FILE "ORIG_HEAD"
34
#define GIT_FETCH_HEAD_FILE "FETCH_HEAD"
35
#define GIT_MERGE_HEAD_FILE "MERGE_HEAD"
Edward Thomson committed
36 37
#define GIT_REVERT_HEAD_FILE "REVERT_HEAD"
#define GIT_CHERRY_PICK_HEAD_FILE "CHERRY_PICK_HEAD"
38 39 40 41 42 43
#define GIT_BISECT_LOG_FILE "BISECT_LOG"
#define GIT_REBASE_MERGE_DIR "rebase-merge/"
#define GIT_REBASE_MERGE_INTERACTIVE_FILE GIT_REBASE_MERGE_DIR "interactive"
#define GIT_REBASE_APPLY_DIR "rebase-apply/"
#define GIT_REBASE_APPLY_REBASING_FILE GIT_REBASE_APPLY_DIR "rebasing"
#define GIT_REBASE_APPLY_APPLYING_FILE GIT_REBASE_APPLY_DIR "applying"
44 45
#define GIT_REFS_HEADS_MASTER_FILE GIT_REFS_HEADS_DIR "master"

46 47 48
#define GIT_STASH_FILE "stash"
#define GIT_REFS_STASH_FILE GIT_REFS_DIR GIT_STASH_FILE

49 50
#define GIT_REFNAME_MAX 1024

51
struct git_reference {
52 53
	git_refdb *db;
	git_ref_t type;
54 55

	union {
56
		git_oid oid;
57 58
		char *symbolic;
	} target;
59 60

	git_oid peel;
61
	char name[0];
62 63
};

64 65
git_reference *git_reference__set_name(git_reference *ref, const char *name);

66 67
int git_reference__normalize_name_lax(char *buffer_out, size_t out_size, const char *name);
int git_reference__normalize_name(git_buf *buf, const char *name, unsigned int flags);
68
int git_reference__update_terminal(git_repository *repo, const char *ref_name, const git_oid *oid);
69
int git_reference__is_valid_name(const char *refname, unsigned int flags);
70
int git_reference__is_branch(const char *ref_name);
71
int git_reference__is_remote(const char *ref_name);
72
int git_reference__is_tag(const char *ref_name);
73

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
/**
 * Lookup a reference by name and try to resolve to an OID.
 *
 * You can control how many dereferences this will attempt to resolve the
 * reference with the `max_deref` parameter, or pass -1 to use a sane
 * default.  If you pass 0 for `max_deref`, this will not attempt to resolve
 * the reference.  For any value of `max_deref` other than 0, not
 * successfully resolving the reference will be reported as an error.

 * The generated reference must be freed by the user.
 *
 * @param reference_out Pointer to the looked-up reference
 * @param repo The repository to look up the reference
 * @param name The long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...)
 * @param max_deref Maximum number of dereferences to make of symbolic refs, 0 means simple lookup, < 0 means use default reasonable value
 * @return 0 on success or < 0 on error; not being able to resolve the reference is an error unless 0 was passed for max_deref
 */
int git_reference_lookup_resolved(
	git_reference **reference_out,
	git_repository *repo,
	const char *name,
	int max_deref);

97
#endif