]>
git.proxmox.com Git - libgit2.git/blob - src/refs.h
2 * Copyright (C) the libgit2 contributors. All rights reserved.
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
7 #ifndef INCLUDE_refs_h__
8 #define INCLUDE_refs_h__
12 #include "git2/refs.h"
13 #include "git2/refdb.h"
18 #define GIT_REFS_DIR "refs/"
19 #define GIT_REFS_HEADS_DIR GIT_REFS_DIR "heads/"
20 #define GIT_REFS_TAGS_DIR GIT_REFS_DIR "tags/"
21 #define GIT_REFS_REMOTES_DIR GIT_REFS_DIR "remotes/"
22 #define GIT_REFS_NOTES_DIR GIT_REFS_DIR "notes/"
23 #define GIT_REFS_DIR_MODE 0777
24 #define GIT_REFS_FILE_MODE 0666
26 #define GIT_RENAMED_REF_FILE GIT_REFS_DIR "RENAMED-REF"
28 #define GIT_SYMREF "ref: "
29 #define GIT_PACKEDREFS_FILE "packed-refs"
30 #define GIT_PACKEDREFS_HEADER "# pack-refs with: peeled fully-peeled "
31 #define GIT_PACKEDREFS_FILE_MODE 0666
33 #define GIT_HEAD_FILE "HEAD"
34 #define GIT_ORIG_HEAD_FILE "ORIG_HEAD"
35 #define GIT_FETCH_HEAD_FILE "FETCH_HEAD"
36 #define GIT_MERGE_HEAD_FILE "MERGE_HEAD"
37 #define GIT_REVERT_HEAD_FILE "REVERT_HEAD"
38 #define GIT_CHERRYPICK_HEAD_FILE "CHERRY_PICK_HEAD"
39 #define GIT_BISECT_LOG_FILE "BISECT_LOG"
40 #define GIT_REBASE_MERGE_DIR "rebase-merge/"
41 #define GIT_REBASE_MERGE_INTERACTIVE_FILE GIT_REBASE_MERGE_DIR "interactive"
42 #define GIT_REBASE_APPLY_DIR "rebase-apply/"
43 #define GIT_REBASE_APPLY_REBASING_FILE GIT_REBASE_APPLY_DIR "rebasing"
44 #define GIT_REBASE_APPLY_APPLYING_FILE GIT_REBASE_APPLY_DIR "applying"
45 #define GIT_REFS_HEADS_MASTER_FILE GIT_REFS_HEADS_DIR "master"
47 #define GIT_SEQUENCER_DIR "sequencer/"
48 #define GIT_SEQUENCER_HEAD_FILE GIT_SEQUENCER_DIR "head"
49 #define GIT_SEQUENCER_OPTIONS_FILE GIT_SEQUENCER_DIR "options"
50 #define GIT_SEQUENCER_TODO_FILE GIT_SEQUENCER_DIR "todo"
52 #define GIT_STASH_FILE "stash"
53 #define GIT_REFS_STASH_FILE GIT_REFS_DIR GIT_STASH_FILE
55 #define GIT_REF_FORMAT__PRECOMPOSE_UNICODE (1u << 16)
57 #define GIT_REFNAME_MAX 1024
59 typedef char git_refname_t
[GIT_REFNAME_MAX
];
61 struct git_reference
{
71 char name
[GIT_FLEX_ARRAY
];
74 git_reference
*git_reference__set_name(git_reference
*ref
, const char *name
);
76 int git_reference__normalize_name(git_buf
*buf
, const char *name
, unsigned int flags
);
77 int git_reference__update_terminal(git_repository
*repo
, const char *ref_name
, const git_oid
*oid
, const git_signature
*sig
, const char *log_message
);
78 int git_reference__is_valid_name(const char *refname
, unsigned int flags
);
79 int git_reference__is_branch(const char *ref_name
);
80 int git_reference__is_remote(const char *ref_name
);
81 int git_reference__is_tag(const char *ref_name
);
82 const char *git_reference__shorthand(const char *name
);
85 * Lookup a reference by name and try to resolve to an OID.
87 * You can control how many dereferences this will attempt to resolve the
88 * reference with the `max_deref` parameter, or pass -1 to use a sane
89 * default. If you pass 0 for `max_deref`, this will not attempt to resolve
90 * the reference. For any value of `max_deref` other than 0, not
91 * successfully resolving the reference will be reported as an error.
93 * The generated reference must be freed by the user.
95 * @param reference_out Pointer to the looked-up reference
96 * @param repo The repository to look up the reference
97 * @param name The long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...)
98 * @param max_deref Maximum number of dereferences to make of symbolic refs, 0 means simple lookup, < 0 means use default reasonable value
99 * @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
101 int git_reference_lookup_resolved(
102 git_reference
**reference_out
,
103 git_repository
*repo
,
107 int git_reference__log_signature(git_signature
**out
, git_repository
*repo
);
109 /** Update a reference after a commit. */
110 int git_reference__update_for_commit(
111 git_repository
*repo
,
113 const char *ref_name
,
115 const char *operation
);