refs.c: change some "flags" to "unsigned int"
[git/git.git] / refs.h
CommitLineData
95fc7512
DB
1#ifndef REFS_H
2#define REFS_H
3
b416af5b
RS
4/*
5 * A ref_transaction represents a collection of ref updates
6 * that should succeed or fail together.
7 *
8 * Calling sequence
9 * ----------------
10 * - Allocate and initialize a `struct ref_transaction` by calling
11 * `ref_transaction_begin()`.
12 *
13 * - List intended ref updates by calling functions like
14 * `ref_transaction_update()` and `ref_transaction_create()`.
15 *
16 * - Call `ref_transaction_commit()` to execute the transaction.
17 * If this succeeds, the ref updates will have taken place and
18 * the transaction cannot be rolled back.
19 *
20 * - At any time call `ref_transaction_free()` to discard the
21 * transaction and free associated resources. In particular,
22 * this rolls back the transaction if it has not been
23 * successfully committed.
24 *
25 * Error handling
26 * --------------
27 *
28 * On error, transaction functions append a message about what
29 * went wrong to the 'err' argument. The message mentions what
30 * ref was being updated (if any) when the error occurred so it
31 * can be passed to 'die' or 'error' as-is.
32 *
33 * The message is appended to err without first clearing err.
34 * err will not be '\n' terminated.
35 */
caa4046c
MH
36struct ref_transaction;
37
89df9c84
MH
38/*
39 * Bit values set in the flags argument passed to each_ref_fn():
40 */
41
42/* Reference is a symbolic reference. */
98ac34b2 43#define REF_ISSYMREF 0x01
89df9c84
MH
44
45/* Reference is a packed reference. */
98ac34b2 46#define REF_ISPACKED 0x02
89df9c84
MH
47
48/*
49 * Reference cannot be resolved to an object name: dangling symbolic
d0f810f0
RS
50 * reference (directly or indirectly), corrupt reference file,
51 * reference exists but name is bad, or symbolic reference refers to
52 * ill-formatted reference name.
89df9c84 53 */
98ac34b2 54#define REF_ISBROKEN 0x04
f4204ab9 55
d0f810f0
RS
56/*
57 * Reference name is not well formed.
58 *
59 * See git-check-ref-format(1) for the definition of well formed ref names.
60 */
61#define REF_BAD_NAME 0x08
62
8a65ff76 63/*
4f78c24c
MH
64 * The signature for the callback function for the for_each_*()
65 * functions below. The memory pointed to by the refname and sha1
66 * arguments is only guaranteed to be valid for the duration of a
67 * single callback invocation.
68 */
69typedef int each_ref_fn(const char *refname,
70 const unsigned char *sha1, int flags, void *cb_data);
71
72/*
73 * The following functions invoke the specified callback function for
74 * each reference indicated. If the function ever returns a nonzero
75 * value, stop the iteration and return that value. Please note that
76 * it is not safe to modify references while an iteration is in
77 * progress, unless the same callback function invocation that
78 * modifies the reference also returns a nonzero value to immediately
79 * stop the iteration.
8a65ff76 80 */
cb5d709f
JH
81extern int head_ref(each_ref_fn, void *);
82extern int for_each_ref(each_ref_fn, void *);
2a8177b6 83extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
84extern int for_each_tag_ref(each_ref_fn, void *);
85extern int for_each_branch_ref(each_ref_fn, void *);
86extern int for_each_remote_ref(each_ref_fn, void *);
29268700 87extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 88extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 89extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 90
9ef6aeb0
HV
91extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
92extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
93extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
94 each_ref_fn fn, void *cb_data);
95extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
96extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
97extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
98
a1bea2c1
JT
99extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
100extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
101
894a9d33
TR
102static inline const char *has_glob_specials(const char *pattern)
103{
104 return strpbrk(pattern, "?*[");
105}
106
f8948e2f
JH
107/* can be used to learn about broken ref and symref */
108extern int for_each_rawref(each_ref_fn, void *);
109
3cf6134a 110extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
24d36f14 111extern void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames);
f8948e2f 112
30249ee6 113/*
9f69d297
MH
114 * Lock the packed-refs file for writing. Flags is passed to
115 * hold_lock_file_for_update(). Return 0 on success.
447ff1bf 116 * Errno is set to something meaningful on error.
9f69d297
MH
117 */
118extern int lock_packed_refs(int flags);
119
120/*
121 * Add a reference to the in-memory packed reference cache. This may
122 * only be called while the packed-refs file is locked (see
123 * lock_packed_refs()). To actually write the packed-refs file, call
124 * commit_packed_refs().
30249ee6
MH
125 */
126extern void add_packed_ref(const char *refname, const unsigned char *sha1);
127
9f69d297
MH
128/*
129 * Write the current version of the packed refs cache from memory to
130 * disk. The packed-refs file must already be locked for writing (see
131 * lock_packed_refs()). Return zero on success.
d3f66555 132 * Sets errno to something meaningful on error.
9f69d297
MH
133 */
134extern int commit_packed_refs(void);
135
136/*
137 * Rollback the lockfile for the packed-refs file, and discard the
138 * in-memory packed reference cache. (The packed-refs file will be
139 * read anew if it is needed again after this function is called.)
140 */
141extern void rollback_packed_refs(void);
142
32d462ce
MH
143/*
144 * Flags for controlling behaviour of pack_refs()
145 * PACK_REFS_PRUNE: Prune loose refs after packing
146 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
147 */
148#define PACK_REFS_PRUNE 0x0001
149#define PACK_REFS_ALL 0x0002
150
151/*
152 * Write a packed-refs file for the current repository.
153 * flags: Combination of the above PACK_REFS_* flags.
154 */
155int pack_refs(unsigned int flags);
156
4a45b2f3
MH
157/*
158 * Rewrite the packed-refs file, omitting any refs listed in
159 * 'refnames'. On error, packed-refs will be unchanged, the return
160 * value is nonzero, and a message about the error is written to the
161 * 'err' strbuf.
162 *
163 * The refs in 'refnames' needn't be sorted. `err` must not be NULL.
164 */
165extern int repack_without_refs(struct string_list *refnames,
60bca085 166 struct strbuf *err);
c9e768bb 167
2c5c66be 168extern int ref_exists(const char *);
e142a3c6 169
e7e0f26e
RS
170extern int is_branch(const char *refname);
171
2312a793
MH
172/*
173 * If refname is a non-symbolic reference that refers to a tag object,
174 * and the tag can be (recursively) dereferenced to a non-tag object,
175 * store the SHA1 of the referred-to object to sha1 and return 0. If
176 * any of these conditions are not met, return a non-zero value.
177 * Symbolic references are considered unpeelable, even if they
178 * ultimately resolve to a peelable tag.
179 */
dfefa935 180extern int peel_ref(const char *refname, unsigned char *sha1);
cf0adba7 181
835e3c99 182/*
31e07f76 183 * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
029cdb4a
RS
184 * REF_NODEREF: act on the ref directly, instead of dereferencing
185 * symbolic references.
186 *
581d4e0c 187 * Other flags are reserved for internal use.
835e3c99 188 */
68db31cc 189#define REF_NODEREF 0x01
95fc7512 190
bd3b02da
RS
191/*
192 * Setup reflog before using. Set errno to something meaningful on failure.
193 */
5524e241 194int log_ref_setup(const char *refname, char *logfile, int bufsize);
859c3017 195
d556fae2 196/** Reads log for the value of ref during at_time. **/
c41a87dd
DA
197extern int read_ref_at(const char *refname, unsigned int flags,
198 unsigned long at_time, int cnt,
dfefa935
MH
199 unsigned char *sha1, char **msg,
200 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 201
4da58835
RS
202/** Check if a particular reflog exists */
203extern int reflog_exists(const char *refname);
204
205/** Delete a reflog */
206extern int delete_reflog(const char *refname);
207
2ff81662 208/* iterate over reflog entries */
883d60fa 209typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
dfefa935 210int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
98f85ff4 211int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
2ff81662 212
eb8381c8
NP
213/*
214 * Calls the specified function for each reflog file until it returns nonzero,
215 * and returns the value
216 */
217extern int for_each_reflog(each_ref_fn, void *);
218
8d9c5010
MH
219#define REFNAME_ALLOW_ONELEVEL 1
220#define REFNAME_REFSPEC_PATTERN 2
221
222/*
dfefa935
MH
223 * Return 0 iff refname has the correct format for a refname according
224 * to the rules described in Documentation/git-check-ref-format.txt.
225 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
8d9c5010
MH
226 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
227 * allow a "*" wildcard character in place of one of the name
f3cc52d8 228 * components. No leading or repeated slashes are accepted.
8d9c5010 229 */
dfefa935 230extern int check_refname_format(const char *refname, int flags);
95fc7512 231
4577e483 232extern const char *prettify_refname(const char *refname);
dfefa935 233extern char *shorten_unambiguous_ref(const char *refname, int strict);
a9c37a72 234
c976d415 235/** rename ref, return 0 on success **/
678d0f4c 236extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 237
7f820bd9
MH
238/**
239 * Resolve refname in the nested "gitlink" repository that is located
240 * at path. If the resolution is successful, return 0 and set sha1 to
241 * the name of the object; otherwise, return a non-zero value.
242 */
243extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
0ebde32c 244
f4124112
MH
245enum action_on_err {
246 UPDATE_REFS_MSG_ON_ERR,
247 UPDATE_REFS_DIE_ON_ERR,
248 UPDATE_REFS_QUIET_ON_ERR
249};
250
caa4046c
MH
251/*
252 * Begin a reference transaction. The reference transaction must
33f9fc59 253 * be freed by calling ref_transaction_free().
caa4046c 254 */
93a644ea 255struct ref_transaction *ref_transaction_begin(struct strbuf *err);
caa4046c 256
caa4046c
MH
257/*
258 * The following functions add a reference check or update to a
259 * ref_transaction. In all of them, refname is the name of the
260 * reference to be affected. The functions make internal copies of
db7516ab
RS
261 * refname and msg, so the caller retains ownership of these parameters.
262 * flags can be REF_NODEREF; it is passed to update_ref_lock().
caa4046c
MH
263 */
264
caa4046c
MH
265/*
266 * Add a reference update to transaction. new_sha1 is the value that
a785d3f7 267 * the reference should have after the update, or null_sha1 if it should
caa4046c
MH
268 * be deleted. If have_old is true, then old_sha1 holds the value
269 * that the reference should have had before the update, or zeros if
270 * it must not have existed beforehand.
8e34800e
RS
271 * Function returns 0 on success and non-zero on failure. A failure to update
272 * means that the transaction as a whole has failed and will need to be
b416af5b 273 * rolled back.
caa4046c 274 */
8e34800e
RS
275int ref_transaction_update(struct ref_transaction *transaction,
276 const char *refname,
277 const unsigned char *new_sha1,
278 const unsigned char *old_sha1,
fec14ec3 279 unsigned int flags, int have_old, const char *msg,
8e34800e 280 struct strbuf *err);
caa4046c
MH
281
282/*
283 * Add a reference creation to transaction. new_sha1 is the value
284 * that the reference should have after the update; it must not be the
285 * null SHA-1. It is verified that the reference does not exist
286 * already.
b416af5b
RS
287 * Function returns 0 on success and non-zero on failure. A failure to create
288 * means that the transaction as a whole has failed and will need to be
289 * rolled back.
caa4046c 290 */
b416af5b
RS
291int ref_transaction_create(struct ref_transaction *transaction,
292 const char *refname,
293 const unsigned char *new_sha1,
fec14ec3 294 unsigned int flags, const char *msg,
b416af5b 295 struct strbuf *err);
caa4046c
MH
296
297/*
298 * Add a reference deletion to transaction. If have_old is true, then
299 * old_sha1 holds the value that the reference should have had before
300 * the update (which must not be the null SHA-1).
8c8bdc0d
RS
301 * Function returns 0 on success and non-zero on failure. A failure to delete
302 * means that the transaction as a whole has failed and will need to be
303 * rolled back.
caa4046c 304 */
8c8bdc0d
RS
305int ref_transaction_delete(struct ref_transaction *transaction,
306 const char *refname,
307 const unsigned char *old_sha1,
fec14ec3 308 unsigned int flags, int have_old, const char *msg,
8c8bdc0d 309 struct strbuf *err);
caa4046c
MH
310
311/*
312 * Commit all of the changes that have been queued in transaction, as
28e6a97e
RS
313 * atomically as possible.
314 *
315 * Returns 0 for success, or one of the below error codes for errors.
caa4046c 316 */
28e6a97e
RS
317/* Naming conflict (for example, the ref names A and A/B conflict). */
318#define TRANSACTION_NAME_CONFLICT -1
319/* All other errors. */
320#define TRANSACTION_GENERIC_ERROR -2
caa4046c 321int ref_transaction_commit(struct ref_transaction *transaction,
db7516ab 322 struct strbuf *err);
caa4046c 323
026bd1d3
RS
324/*
325 * Free an existing transaction and all associated data.
326 */
327void ref_transaction_free(struct ref_transaction *transaction);
328
f4124112 329/** Lock a ref and then write its file */
3d9f037c 330int update_ref(const char *action, const char *refname,
fec14ec3
MH
331 const unsigned char *sha1, const unsigned char *oldval,
332 unsigned int flags, enum action_on_err onerr);
3d9f037c 333
daebaa78
JH
334extern int parse_hide_refs_config(const char *var, const char *value, const char *);
335extern int ref_is_hidden(const char *);
336
fa5b1830
MH
337enum expire_reflog_flags {
338 EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
339 EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
340 EXPIRE_REFLOGS_VERBOSE = 1 << 2,
341 EXPIRE_REFLOGS_REWRITE = 1 << 3
342};
343
344/*
345 * The following interface is used for reflog expiration. The caller
346 * calls reflog_expire(), supplying it with three callback functions,
347 * of the following types. The callback functions define the
348 * expiration policy that is desired.
349 *
350 * reflog_expiry_prepare_fn -- Called once after the reference is
351 * locked.
352 *
353 * reflog_expiry_should_prune_fn -- Called once for each entry in the
354 * existing reflog. It should return true iff that entry should be
355 * pruned.
356 *
357 * reflog_expiry_cleanup_fn -- Called once before the reference is
358 * unlocked again.
359 */
360typedef void reflog_expiry_prepare_fn(const char *refname,
361 const unsigned char *sha1,
362 void *cb_data);
363typedef int reflog_expiry_should_prune_fn(unsigned char *osha1,
364 unsigned char *nsha1,
365 const char *email,
366 unsigned long timestamp, int tz,
367 const char *message, void *cb_data);
368typedef void reflog_expiry_cleanup_fn(void *cb_data);
369
370/*
371 * Expire reflog entries for the specified reference. sha1 is the old
372 * value of the reference. flags is a combination of the constants in
373 * enum expire_reflog_flags. The three function pointers are described
374 * above. On success, return zero.
375 */
376extern int reflog_expire(const char *refname, const unsigned char *sha1,
377 unsigned int flags,
378 reflog_expiry_prepare_fn prepare_fn,
379 reflog_expiry_should_prune_fn should_prune_fn,
380 reflog_expiry_cleanup_fn cleanup_fn,
381 void *policy_cb_data);
382
95fc7512 383#endif /* REFS_H */