refs.c: make sure log_ref_setup returns a meaningful errno
[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
caa4046c
MH
13struct ref_transaction;
14
89df9c84
MH
15/*
16 * Bit values set in the flags argument passed to each_ref_fn():
17 */
18
19/* Reference is a symbolic reference. */
98ac34b2 20#define REF_ISSYMREF 0x01
89df9c84
MH
21
22/* Reference is a packed reference. */
98ac34b2 23#define REF_ISPACKED 0x02
89df9c84
MH
24
25/*
26 * Reference cannot be resolved to an object name: dangling symbolic
27 * reference (directly or indirectly), corrupt reference file, or
28 * symbolic reference refers to ill-formatted reference name.
29 */
98ac34b2 30#define REF_ISBROKEN 0x04
f4204ab9 31
8a65ff76 32/*
4f78c24c
MH
33 * The signature for the callback function for the for_each_*()
34 * functions below. The memory pointed to by the refname and sha1
35 * arguments is only guaranteed to be valid for the duration of a
36 * single callback invocation.
37 */
38typedef int each_ref_fn(const char *refname,
39 const unsigned char *sha1, int flags, void *cb_data);
40
41/*
42 * The following functions invoke the specified callback function for
43 * each reference indicated. If the function ever returns a nonzero
44 * value, stop the iteration and return that value. Please note that
45 * it is not safe to modify references while an iteration is in
46 * progress, unless the same callback function invocation that
47 * modifies the reference also returns a nonzero value to immediately
48 * stop the iteration.
8a65ff76 49 */
cb5d709f
JH
50extern int head_ref(each_ref_fn, void *);
51extern int for_each_ref(each_ref_fn, void *);
2a8177b6 52extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
53extern int for_each_tag_ref(each_ref_fn, void *);
54extern int for_each_branch_ref(each_ref_fn, void *);
55extern int for_each_remote_ref(each_ref_fn, void *);
29268700 56extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 57extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 58extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 59
9ef6aeb0
HV
60extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
61extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
62extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
63 each_ref_fn fn, void *cb_data);
64extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
65extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
66extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
67
a1bea2c1
JT
68extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
69extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
70
894a9d33
TR
71static inline const char *has_glob_specials(const char *pattern)
72{
73 return strpbrk(pattern, "?*[");
74}
75
f8948e2f
JH
76/* can be used to learn about broken ref and symref */
77extern int for_each_rawref(each_ref_fn, void *);
78
3cf6134a 79extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
e6bea66d 80extern void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list* refnames);
f8948e2f 81
30249ee6 82/*
9f69d297
MH
83 * Lock the packed-refs file for writing. Flags is passed to
84 * hold_lock_file_for_update(). Return 0 on success.
447ff1bf 85 * Errno is set to something meaningful on error.
9f69d297
MH
86 */
87extern int lock_packed_refs(int flags);
88
89/*
90 * Add a reference to the in-memory packed reference cache. This may
91 * only be called while the packed-refs file is locked (see
92 * lock_packed_refs()). To actually write the packed-refs file, call
93 * commit_packed_refs().
30249ee6
MH
94 */
95extern void add_packed_ref(const char *refname, const unsigned char *sha1);
96
9f69d297
MH
97/*
98 * Write the current version of the packed refs cache from memory to
99 * disk. The packed-refs file must already be locked for writing (see
100 * lock_packed_refs()). Return zero on success.
101 */
102extern int commit_packed_refs(void);
103
104/*
105 * Rollback the lockfile for the packed-refs file, and discard the
106 * in-memory packed reference cache. (The packed-refs file will be
107 * read anew if it is needed again after this function is called.)
108 */
109extern void rollback_packed_refs(void);
110
32d462ce
MH
111/*
112 * Flags for controlling behaviour of pack_refs()
113 * PACK_REFS_PRUNE: Prune loose refs after packing
114 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
115 */
116#define PACK_REFS_PRUNE 0x0001
117#define PACK_REFS_ALL 0x0002
118
119/*
120 * Write a packed-refs file for the current repository.
121 * flags: Combination of the above PACK_REFS_* flags.
122 */
123int pack_refs(unsigned int flags);
124
60bca085
RS
125extern int repack_without_refs(const char **refnames, int n,
126 struct strbuf *err);
c9e768bb 127
2c5c66be 128extern int ref_exists(const char *);
e142a3c6 129
2312a793
MH
130/*
131 * If refname is a non-symbolic reference that refers to a tag object,
132 * and the tag can be (recursively) dereferenced to a non-tag object,
133 * store the SHA1 of the referred-to object to sha1 and return 0. If
134 * any of these conditions are not met, return a non-zero value.
135 * Symbolic references are considered unpeelable, even if they
136 * ultimately resolve to a peelable tag.
137 */
dfefa935 138extern int peel_ref(const char *refname, unsigned char *sha1);
cf0adba7 139
4bd18c43 140/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
dfefa935 141extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
4bd18c43
SP
142
143/** Locks any ref (for 'HEAD' type refs). */
68db31cc 144#define REF_NODEREF 0x01
dfefa935
MH
145extern struct ref_lock *lock_any_ref_for_update(const char *refname,
146 const unsigned char *old_sha1,
9bbb0fa1 147 int flags, int *type_p);
95fc7512 148
435fc852
BC
149/** Close the file descriptor owned by a lock and return the status */
150extern int close_ref(struct ref_lock *lock);
151
152/** Close and commit the ref locked by the lock */
153extern int commit_ref(struct ref_lock *lock);
154
4bd18c43 155/** Release any lock taken but not written. **/
e5f38ec3 156extern void unlock_ref(struct ref_lock *lock);
95fc7512 157
4bd18c43
SP
158/** Writes sha1 into the ref specified by the lock. **/
159extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 160
bd3b02da
RS
161/*
162 * Setup reflog before using. Set errno to something meaningful on failure.
163 */
5524e241 164int log_ref_setup(const char *refname, char *logfile, int bufsize);
859c3017 165
d556fae2 166/** Reads log for the value of ref during at_time. **/
dfefa935
MH
167extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
168 unsigned char *sha1, char **msg,
169 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 170
4da58835
RS
171/** Check if a particular reflog exists */
172extern int reflog_exists(const char *refname);
173
174/** Delete a reflog */
175extern int delete_reflog(const char *refname);
176
2ff81662 177/* iterate over reflog entries */
883d60fa 178typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
dfefa935 179int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
98f85ff4 180int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
2ff81662 181
eb8381c8
NP
182/*
183 * Calls the specified function for each reflog file until it returns nonzero,
184 * and returns the value
185 */
186extern int for_each_reflog(each_ref_fn, void *);
187
8d9c5010
MH
188#define REFNAME_ALLOW_ONELEVEL 1
189#define REFNAME_REFSPEC_PATTERN 2
dce4bab6 190#define REFNAME_DOT_COMPONENT 4
8d9c5010
MH
191
192/*
dfefa935
MH
193 * Return 0 iff refname has the correct format for a refname according
194 * to the rules described in Documentation/git-check-ref-format.txt.
195 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
8d9c5010
MH
196 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
197 * allow a "*" wildcard character in place of one of the name
dce4bab6
MH
198 * components. No leading or repeated slashes are accepted. If
199 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
200 * components to start with "." (but not a whole component equal to
201 * "." or "..").
8d9c5010 202 */
dfefa935 203extern int check_refname_format(const char *refname, int flags);
95fc7512 204
4577e483 205extern const char *prettify_refname(const char *refname);
dfefa935 206extern char *shorten_unambiguous_ref(const char *refname, int strict);
a9c37a72 207
c976d415 208/** rename ref, return 0 on success **/
678d0f4c 209extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 210
7f820bd9
MH
211/**
212 * Resolve refname in the nested "gitlink" repository that is located
213 * at path. If the resolution is successful, return 0 and set sha1 to
214 * the name of the object; otherwise, return a non-zero value.
215 */
216extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
0ebde32c 217
f4124112
MH
218enum action_on_err {
219 UPDATE_REFS_MSG_ON_ERR,
220 UPDATE_REFS_DIE_ON_ERR,
221 UPDATE_REFS_QUIET_ON_ERR
222};
223
caa4046c
MH
224/*
225 * Begin a reference transaction. The reference transaction must
33f9fc59 226 * be freed by calling ref_transaction_free().
caa4046c
MH
227 */
228struct ref_transaction *ref_transaction_begin(void);
229
caa4046c
MH
230/*
231 * The following functions add a reference check or update to a
232 * ref_transaction. In all of them, refname is the name of the
233 * reference to be affected. The functions make internal copies of
234 * refname, so the caller retains ownership of the parameter. flags
235 * can be REF_NODEREF; it is passed to update_ref_lock().
236 */
237
caa4046c
MH
238/*
239 * Add a reference update to transaction. new_sha1 is the value that
240 * the reference should have after the update, or zeros if it should
241 * be deleted. If have_old is true, then old_sha1 holds the value
242 * that the reference should have had before the update, or zeros if
243 * it must not have existed beforehand.
244 */
245void ref_transaction_update(struct ref_transaction *transaction,
246 const char *refname,
f1c9350a
RS
247 const unsigned char *new_sha1,
248 const unsigned char *old_sha1,
caa4046c
MH
249 int flags, int have_old);
250
251/*
252 * Add a reference creation to transaction. new_sha1 is the value
253 * that the reference should have after the update; it must not be the
254 * null SHA-1. It is verified that the reference does not exist
255 * already.
256 */
257void ref_transaction_create(struct ref_transaction *transaction,
258 const char *refname,
f1c9350a 259 const unsigned char *new_sha1,
caa4046c
MH
260 int flags);
261
262/*
263 * Add a reference deletion to transaction. If have_old is true, then
264 * old_sha1 holds the value that the reference should have had before
265 * the update (which must not be the null SHA-1).
266 */
267void ref_transaction_delete(struct ref_transaction *transaction,
268 const char *refname,
f1c9350a 269 const unsigned char *old_sha1,
caa4046c
MH
270 int flags, int have_old);
271
272/*
273 * Commit all of the changes that have been queued in transaction, as
274 * atomically as possible. Return a nonzero value if there is a
33f9fc59 275 * problem.
995f8746
RS
276 * If err is non-NULL we will add an error string to it to explain why
277 * the transaction failed. The string does not end in newline.
caa4046c
MH
278 */
279int ref_transaction_commit(struct ref_transaction *transaction,
995f8746
RS
280 const char *msg, struct strbuf *err,
281 enum action_on_err onerr);
caa4046c 282
026bd1d3
RS
283/*
284 * Free an existing transaction and all associated data.
285 */
286void ref_transaction_free(struct ref_transaction *transaction);
287
f4124112 288/** Lock a ref and then write its file */
3d9f037c
CR
289int update_ref(const char *action, const char *refname,
290 const unsigned char *sha1, const unsigned char *oldval,
291 int flags, enum action_on_err onerr);
292
daebaa78
JH
293extern int parse_hide_refs_config(const char *var, const char *value, const char *);
294extern int ref_is_hidden(const char *);
295
95fc7512 296#endif /* REFS_H */