peel_object(): give more specific information in return value
[git/git.git] / refs.h
CommitLineData
95fc7512
DB
1#ifndef REFS_H
2#define REFS_H
3
4bd18c43 4struct ref_lock {
434cd0cd 5 char *ref_name;
1655707c 6 char *orig_ref_name;
c33d5174 7 struct lock_file *lk;
4bd18c43
SP
8 unsigned char old_sha1[20];
9 int lock_fd;
732232a1 10 int force_write;
4bd18c43
SP
11};
12
89df9c84
MH
13/*
14 * Bit values set in the flags argument passed to each_ref_fn():
15 */
16
17/* Reference is a symbolic reference. */
98ac34b2 18#define REF_ISSYMREF 0x01
89df9c84
MH
19
20/* Reference is a packed reference. */
98ac34b2 21#define REF_ISPACKED 0x02
89df9c84
MH
22
23/*
24 * Reference cannot be resolved to an object name: dangling symbolic
25 * reference (directly or indirectly), corrupt reference file, or
26 * symbolic reference refers to ill-formatted reference name.
27 */
98ac34b2 28#define REF_ISBROKEN 0x04
f4204ab9 29
8a65ff76 30/*
432ad41e
MH
31 * Calls the specified function for each ref file until it returns
32 * nonzero, and returns the value. Please note that it is not safe to
33 * modify references while an iteration is in progress, unless the
34 * same callback function invocation that modifies the reference also
35 * returns a nonzero value to immediately stop the iteration.
8a65ff76 36 */
8da19775 37typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
cb5d709f
JH
38extern int head_ref(each_ref_fn, void *);
39extern int for_each_ref(each_ref_fn, void *);
2a8177b6 40extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
41extern int for_each_tag_ref(each_ref_fn, void *);
42extern int for_each_branch_ref(each_ref_fn, void *);
43extern int for_each_remote_ref(each_ref_fn, void *);
29268700 44extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 45extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 46extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 47
9ef6aeb0
HV
48extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
49extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
50extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
51 each_ref_fn fn, void *cb_data);
52extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
53extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
54extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
55
a1bea2c1
JT
56extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
57extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
58
894a9d33
TR
59static inline const char *has_glob_specials(const char *pattern)
60{
61 return strpbrk(pattern, "?*[");
62}
63
f8948e2f
JH
64/* can be used to learn about broken ref and symref */
65extern int for_each_rawref(each_ref_fn, void *);
66
3cf6134a 67extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
f8948e2f 68
30249ee6
MH
69/*
70 * Add a reference to the in-memory packed reference cache. To actually
71 * write the reference to the packed-refs file, call pack_refs().
72 */
73extern void add_packed_ref(const char *refname, const unsigned char *sha1);
74
2c5c66be 75extern int ref_exists(const char *);
e142a3c6 76
dfefa935 77extern int peel_ref(const char *refname, unsigned char *sha1);
cf0adba7 78
4bd18c43 79/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
dfefa935 80extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
4bd18c43
SP
81
82/** Locks any ref (for 'HEAD' type refs). */
68db31cc 83#define REF_NODEREF 0x01
dfefa935
MH
84extern struct ref_lock *lock_any_ref_for_update(const char *refname,
85 const unsigned char *old_sha1,
86 int flags);
95fc7512 87
435fc852
BC
88/** Close the file descriptor owned by a lock and return the status */
89extern int close_ref(struct ref_lock *lock);
90
91/** Close and commit the ref locked by the lock */
92extern int commit_ref(struct ref_lock *lock);
93
4bd18c43 94/** Release any lock taken but not written. **/
e5f38ec3 95extern void unlock_ref(struct ref_lock *lock);
95fc7512 96
4bd18c43
SP
97/** Writes sha1 into the ref specified by the lock. **/
98extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 99
8be8bde7
MH
100/*
101 * Invalidate the reference cache for the specified submodule. Use
102 * submodule=NULL to invalidate the cache for the main module. This
103 * function must be called if references are changed via a mechanism
104 * other than the refs API.
105 */
106extern void invalidate_ref_cache(const char *submodule);
107
859c3017 108/** Setup reflog before using. **/
157aaea5 109int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
859c3017 110
d556fae2 111/** Reads log for the value of ref during at_time. **/
dfefa935
MH
112extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
113 unsigned char *sha1, char **msg,
114 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 115
2ff81662 116/* iterate over reflog entries */
883d60fa 117typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
dfefa935
MH
118int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
119int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long, void *cb_data);
2ff81662 120
eb8381c8
NP
121/*
122 * Calls the specified function for each reflog file until it returns nonzero,
123 * and returns the value
124 */
125extern int for_each_reflog(each_ref_fn, void *);
126
8d9c5010
MH
127#define REFNAME_ALLOW_ONELEVEL 1
128#define REFNAME_REFSPEC_PATTERN 2
dce4bab6 129#define REFNAME_DOT_COMPONENT 4
8d9c5010
MH
130
131/*
dfefa935
MH
132 * Return 0 iff refname has the correct format for a refname according
133 * to the rules described in Documentation/git-check-ref-format.txt.
134 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
8d9c5010
MH
135 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
136 * allow a "*" wildcard character in place of one of the name
dce4bab6
MH
137 * components. No leading or repeated slashes are accepted. If
138 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
139 * components to start with "." (but not a whole component equal to
140 * "." or "..").
8d9c5010 141 */
dfefa935 142extern int check_refname_format(const char *refname, int flags);
95fc7512 143
4577e483 144extern const char *prettify_refname(const char *refname);
dfefa935 145extern char *shorten_unambiguous_ref(const char *refname, int strict);
a9c37a72 146
c976d415 147/** rename ref, return 0 on success **/
678d0f4c 148extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 149
7f820bd9
MH
150/**
151 * Resolve refname in the nested "gitlink" repository that is located
152 * at path. If the resolution is successful, return 0 and set sha1 to
153 * the name of the object; otherwise, return a non-zero value.
154 */
155extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
0ebde32c 156
3d9f037c
CR
157/** lock a ref and then write its file */
158enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
159int update_ref(const char *action, const char *refname,
160 const unsigned char *sha1, const unsigned char *oldval,
161 int flags, enum action_on_err onerr);
162
95fc7512 163#endif /* REFS_H */