]>
Commit | Line | Data |
---|---|---|
95fc7512 DB |
1 | #ifndef REFS_H |
2 | #define REFS_H | |
3 | ||
504c4d42 | 4 | struct object_id; |
077be78d | 5 | struct ref_store; |
ef3ca954 | 6 | struct repository; |
504c4d42 NTND |
7 | struct strbuf; |
8 | struct string_list; | |
ef3ca954 | 9 | struct string_list_item; |
17eff96b | 10 | struct worktree; |
504c4d42 | 11 | |
fb58c8d5 MH |
12 | /* |
13 | * Resolve a reference, recursively following symbolic refererences. | |
14 | * | |
54fad661 RS |
15 | * Return the name of the non-symbolic reference that ultimately pointed |
16 | * at the resolved object name. The return value, if not NULL, is a | |
17 | * pointer into either a static buffer or the input ref. | |
18 | * | |
49e61479 | 19 | * If oid is non-NULL, store the referred-to object's name in it. |
fb58c8d5 MH |
20 | * |
21 | * If the reference cannot be resolved to an object, the behavior | |
22 | * depends on the RESOLVE_REF_READING flag: | |
23 | * | |
24 | * - If RESOLVE_REF_READING is set, return NULL. | |
25 | * | |
49e61479 | 26 | * - If RESOLVE_REF_READING is not set, clear oid and return the name of |
fb58c8d5 MH |
27 | * the last reference name in the chain, which will either be a non-symbolic |
28 | * reference or an undefined reference. If this is a prelude to | |
29 | * "writing" to the ref, the return value is the name of the ref | |
30 | * that will actually be created or changed. | |
31 | * | |
32 | * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one | |
49e61479 | 33 | * level of symbolic reference. The value stored in oid for a symbolic |
34 | * reference will always be null_oid in this case, and the return | |
fb58c8d5 MH |
35 | * value is the reference that the symref refers to directly. |
36 | * | |
37 | * If flags is non-NULL, set the value that it points to the | |
38 | * combination of REF_ISPACKED (if the reference was found among the | |
39 | * packed references), REF_ISSYMREF (if the initial reference was a | |
40 | * symbolic reference), REF_BAD_NAME (if the reference name is ill | |
41 | * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN | |
42 | * (if the ref is malformed or has a bad name). See refs.h for more detail | |
43 | * on each flag. | |
44 | * | |
45 | * If ref is not a properly-formatted, normalized reference, return | |
46 | * NULL. If more than MAXDEPTH recursive symbolic lookups are needed, | |
47 | * give up and return NULL. | |
48 | * | |
49 | * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their | |
50 | * name is invalid according to git-check-ref-format(1). If the name | |
49e61479 | 51 | * is bad then the value stored in oid will be null_oid and the two |
fb58c8d5 MH |
52 | * flags REF_ISBROKEN and REF_BAD_NAME will be set. |
53 | * | |
54 | * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/ | |
55 | * directory and do not consist of all caps and underscores cannot be | |
56 | * resolved. The function returns NULL for such ref names. | |
57 | * Caps and underscores refers to the special refs, such as HEAD, | |
58 | * FETCH_HEAD and friends, that all live outside of the refs/ directory. | |
59 | */ | |
60 | #define RESOLVE_REF_READING 0x01 | |
61 | #define RESOLVE_REF_NO_RECURSE 0x02 | |
62 | #define RESOLVE_REF_ALLOW_BAD_NAME 0x04 | |
63 | ||
7d2df051 NTND |
64 | const char *refs_resolve_ref_unsafe(struct ref_store *refs, |
65 | const char *refname, | |
66 | int resolve_flags, | |
49e61479 | 67 | struct object_id *oid, |
7d2df051 | 68 | int *flags); |
1354c9b2 | 69 | const char *resolve_ref_unsafe(const char *refname, int resolve_flags, |
49e61479 | 70 | struct object_id *oid, int *flags); |
fb58c8d5 | 71 | |
7d2df051 NTND |
72 | char *refs_resolve_refdup(struct ref_store *refs, |
73 | const char *refname, int resolve_flags, | |
0f2dc722 | 74 | struct object_id *oid, int *flags); |
1354c9b2 | 75 | char *resolve_refdup(const char *refname, int resolve_flags, |
0f2dc722 | 76 | struct object_id *oid, int *flags); |
fb58c8d5 | 77 | |
7d2df051 | 78 | int refs_read_ref_full(struct ref_store *refs, const char *refname, |
34c290a6 | 79 | int resolve_flags, struct object_id *oid, int *flags); |
1354c9b2 | 80 | int read_ref_full(const char *refname, int resolve_flags, |
34c290a6 | 81 | struct object_id *oid, int *flags); |
82 | int read_ref(const char *refname, struct object_id *oid); | |
fb58c8d5 | 83 | |
7d2df051 NTND |
84 | /* |
85 | * Return 0 if a reference named refname could be created without | |
86 | * conflicting with the name of an existing reference. Otherwise, | |
87 | * return a negative value and write an explanation to err. If extras | |
88 | * is non-NULL, it is a list of additional refnames with which refname | |
89 | * is not allowed to conflict. If skip is non-NULL, ignore potential | |
90 | * conflicts with refs in skip (e.g., because they are scheduled for | |
91 | * deletion in the same operation). Behavior is undefined if the same | |
92 | * name is listed in both extras and skip. | |
93 | * | |
94 | * Two reference names conflict if one of them exactly matches the | |
95 | * leading components of the other; e.g., "foo/bar" conflicts with | |
96 | * both "foo" and with "foo/bar/baz" but not with "foo/bar" or | |
97 | * "foo/barbados". | |
98 | * | |
99 | * extras and skip must be sorted. | |
100 | */ | |
101 | ||
102 | int refs_verify_refname_available(struct ref_store *refs, | |
103 | const char *refname, | |
b05855b5 | 104 | const struct string_list *extras, |
7d2df051 NTND |
105 | const struct string_list *skip, |
106 | struct strbuf *err); | |
107 | ||
1354c9b2 | 108 | int ref_exists(const char *refname); |
fb58c8d5 | 109 | |
341fb286 CW |
110 | int should_autocreate_reflog(const char *refname); |
111 | ||
1354c9b2 | 112 | int is_branch(const char *refname); |
fb58c8d5 | 113 | |
55454427 | 114 | int refs_init_db(struct strbuf *err); |
6fb5acfd | 115 | |
fb58c8d5 MH |
116 | /* |
117 | * If refname is a non-symbolic reference that refers to a tag object, | |
118 | * and the tag can be (recursively) dereferenced to a non-tag object, | |
b420d909 | 119 | * store the object ID of the referred-to object to oid and return 0. |
120 | * If any of these conditions are not met, return a non-zero value. | |
fb58c8d5 MH |
121 | * Symbolic references are considered unpeelable, even if they |
122 | * ultimately resolve to a peelable tag. | |
123 | */ | |
7d2df051 | 124 | int refs_peel_ref(struct ref_store *refs, const char *refname, |
b420d909 | 125 | struct object_id *oid); |
126 | int peel_ref(const char *refname, struct object_id *oid); | |
fb58c8d5 MH |
127 | |
128 | /** | |
a8355bb7 MH |
129 | * Resolve refname in the nested "gitlink" repository in the specified |
130 | * submodule (which must be non-NULL). If the resolution is | |
78fb4579 | 131 | * successful, return 0 and set oid to the name of the object; |
a8355bb7 | 132 | * otherwise, return a non-zero value. |
fb58c8d5 | 133 | */ |
a8355bb7 | 134 | int resolve_gitlink_ref(const char *submodule, const char *refname, |
a98e6101 | 135 | struct object_id *oid); |
fb58c8d5 MH |
136 | |
137 | /* | |
138 | * Return true iff abbrev_name is a possible abbreviation for | |
139 | * full_name according to the rules defined by ref_rev_parse_rules in | |
140 | * refs.c. | |
141 | */ | |
1354c9b2 | 142 | int refname_match(const char *abbrev_name, const char *full_name); |
fb58c8d5 | 143 | |
b4be7410 BW |
144 | /* |
145 | * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add | |
146 | * the results to 'prefixes' | |
147 | */ | |
873cd28a JK |
148 | struct strvec; |
149 | void expand_ref_prefix(struct strvec *prefixes, const char *prefix); | |
b4be7410 | 150 | |
0b1dbf53 | 151 | int expand_ref(struct repository *r, const char *str, int len, struct object_id *oid, char **ref); |
d8984c53 | 152 | int repo_dwim_ref(struct repository *r, const char *str, int len, struct object_id *oid, char **ref); |
56700903 | 153 | int repo_dwim_log(struct repository *r, const char *str, int len, struct object_id *oid, char **ref); |
cca5fa64 | 154 | int dwim_ref(const char *str, int len, struct object_id *oid, char **ref); |
334dc52f | 155 | int dwim_log(const char *str, int len, struct object_id *oid, char **ref); |
fb58c8d5 | 156 | |
8747ebb7 DGW |
157 | /* |
158 | * Retrieves the default branch name for newly-initialized repositories. | |
159 | * | |
160 | * The return value of `repo_default_branch_name()` is an allocated string. The | |
161 | * return value of `git_default_branch_name()` is a singleton. | |
162 | */ | |
163 | const char *git_default_branch_name(void); | |
164 | char *repo_default_branch_name(struct repository *r); | |
165 | ||
b416af5b | 166 | /* |
30173b88 MH |
167 | * A ref_transaction represents a collection of reference updates that |
168 | * should succeed or fail together. | |
b416af5b RS |
169 | * |
170 | * Calling sequence | |
171 | * ---------------- | |
30173b88 | 172 | * |
b416af5b RS |
173 | * - Allocate and initialize a `struct ref_transaction` by calling |
174 | * `ref_transaction_begin()`. | |
175 | * | |
30173b88 MH |
176 | * - Specify the intended ref updates by calling one or more of the |
177 | * following functions: | |
178 | * - `ref_transaction_update()` | |
179 | * - `ref_transaction_create()` | |
180 | * - `ref_transaction_delete()` | |
181 | * - `ref_transaction_verify()` | |
182 | * | |
183 | * - Then either: | |
184 | * | |
185 | * - Optionally call `ref_transaction_prepare()` to prepare the | |
186 | * transaction. This locks all references, checks preconditions, | |
187 | * etc. but doesn't finalize anything. If this step fails, the | |
188 | * transaction has been closed and can only be freed. If this step | |
189 | * succeeds, then `ref_transaction_commit()` is almost certain to | |
190 | * succeed. However, you can still call `ref_transaction_abort()` | |
191 | * if you decide not to commit the transaction after all. | |
192 | * | |
193 | * - Call `ref_transaction_commit()` to execute the transaction, | |
194 | * make the changes permanent, and release all locks. If you | |
195 | * haven't already called `ref_transaction_prepare()`, then | |
196 | * `ref_transaction_commit()` calls it for you. | |
197 | * | |
198 | * Or | |
199 | * | |
200 | * - Call `initial_ref_transaction_commit()` if the ref database is | |
201 | * known to be empty and have no other writers (e.g. during | |
202 | * clone). This is likely to be much faster than | |
203 | * `ref_transaction_commit()`. `ref_transaction_prepare()` should | |
204 | * *not* be called before `initial_ref_transaction_commit()`. | |
205 | * | |
206 | * - Then finally, call `ref_transaction_free()` to free the | |
207 | * `ref_transaction` data structure. | |
208 | * | |
209 | * At any time before calling `ref_transaction_commit()`, you can call | |
210 | * `ref_transaction_abort()` to abort the transaction, rollback any | |
211 | * locks, and free any associated resources (including the | |
212 | * `ref_transaction` data structure). | |
213 | * | |
214 | * Putting it all together, a complete reference update looks like | |
215 | * | |
216 | * struct ref_transaction *transaction; | |
217 | * struct strbuf err = STRBUF_INIT; | |
218 | * int ret = 0; | |
219 | * | |
220 | * transaction = ref_store_transaction_begin(refs, &err); | |
221 | * if (!transaction || | |
222 | * ref_transaction_update(...) || | |
223 | * ref_transaction_create(...) || | |
224 | * ...etc... || | |
225 | * ref_transaction_commit(transaction, &err)) { | |
226 | * error("%s", err.buf); | |
227 | * ret = -1; | |
228 | * } | |
229 | * ref_transaction_free(transaction); | |
230 | * strbuf_release(&err); | |
231 | * return ret; | |
b416af5b RS |
232 | * |
233 | * Error handling | |
234 | * -------------- | |
235 | * | |
236 | * On error, transaction functions append a message about what | |
237 | * went wrong to the 'err' argument. The message mentions what | |
238 | * ref was being updated (if any) when the error occurred so it | |
239 | * can be passed to 'die' or 'error' as-is. | |
240 | * | |
241 | * The message is appended to err without first clearing err. | |
242 | * err will not be '\n' terminated. | |
49386868 DT |
243 | * |
244 | * Caveats | |
245 | * ------- | |
246 | * | |
247 | * Note that no locks are taken, and no refs are read, until | |
30173b88 MH |
248 | * `ref_transaction_prepare()` or `ref_transaction_commit()` is |
249 | * called. So, for example, `ref_transaction_verify()` won't report a | |
250 | * verification failure until the commit is attempted. | |
b416af5b | 251 | */ |
caa4046c MH |
252 | struct ref_transaction; |
253 | ||
89df9c84 | 254 | /* |
3bc581b9 MH |
255 | * Bit values set in the flags argument passed to each_ref_fn() and |
256 | * stored in ref_iterator::flags. Other bits are for internal use | |
257 | * only: | |
89df9c84 MH |
258 | */ |
259 | ||
260 | /* Reference is a symbolic reference. */ | |
98ac34b2 | 261 | #define REF_ISSYMREF 0x01 |
89df9c84 MH |
262 | |
263 | /* Reference is a packed reference. */ | |
98ac34b2 | 264 | #define REF_ISPACKED 0x02 |
89df9c84 MH |
265 | |
266 | /* | |
267 | * Reference cannot be resolved to an object name: dangling symbolic | |
d0f810f0 RS |
268 | * reference (directly or indirectly), corrupt reference file, |
269 | * reference exists but name is bad, or symbolic reference refers to | |
270 | * ill-formatted reference name. | |
89df9c84 | 271 | */ |
98ac34b2 | 272 | #define REF_ISBROKEN 0x04 |
f4204ab9 | 273 | |
d0f810f0 RS |
274 | /* |
275 | * Reference name is not well formed. | |
276 | * | |
277 | * See git-check-ref-format(1) for the definition of well formed ref names. | |
278 | */ | |
279 | #define REF_BAD_NAME 0x08 | |
280 | ||
8a65ff76 | 281 | /* |
4f78c24c | 282 | * The signature for the callback function for the for_each_*() |
78fb4579 | 283 | * functions below. The memory pointed to by the refname and oid |
4f78c24c MH |
284 | * arguments is only guaranteed to be valid for the duration of a |
285 | * single callback invocation. | |
286 | */ | |
287 | typedef int each_ref_fn(const char *refname, | |
2b2a5be3 MH |
288 | const struct object_id *oid, int flags, void *cb_data); |
289 | ||
4a6067cd SB |
290 | /* |
291 | * The same as each_ref_fn, but also with a repository argument that | |
292 | * contains the repository associated with the callback. | |
293 | */ | |
294 | typedef int each_repo_ref_fn(struct repository *r, | |
295 | const char *refname, | |
296 | const struct object_id *oid, | |
297 | int flags, | |
298 | void *cb_data); | |
299 | ||
4f78c24c MH |
300 | /* |
301 | * The following functions invoke the specified callback function for | |
302 | * each reference indicated. If the function ever returns a nonzero | |
303 | * value, stop the iteration and return that value. Please note that | |
304 | * it is not safe to modify references while an iteration is in | |
305 | * progress, unless the same callback function invocation that | |
306 | * modifies the reference also returns a nonzero value to immediately | |
adac8115 | 307 | * stop the iteration. Returned references are sorted. |
8a65ff76 | 308 | */ |
62f0b399 NTND |
309 | int refs_head_ref(struct ref_store *refs, |
310 | each_ref_fn fn, void *cb_data); | |
7d2df051 NTND |
311 | int refs_for_each_ref(struct ref_store *refs, |
312 | each_ref_fn fn, void *cb_data); | |
313 | int refs_for_each_ref_in(struct ref_store *refs, const char *prefix, | |
314 | each_ref_fn fn, void *cb_data); | |
315 | int refs_for_each_tag_ref(struct ref_store *refs, | |
316 | each_ref_fn fn, void *cb_data); | |
317 | int refs_for_each_branch_ref(struct ref_store *refs, | |
318 | each_ref_fn fn, void *cb_data); | |
319 | int refs_for_each_remote_ref(struct ref_store *refs, | |
320 | each_ref_fn fn, void *cb_data); | |
321 | ||
126c1cce | 322 | /* just iterates the head ref. */ |
1354c9b2 | 323 | int head_ref(each_ref_fn fn, void *cb_data); |
126c1cce HW |
324 | |
325 | /* iterates all refs. */ | |
1354c9b2 | 326 | int for_each_ref(each_ref_fn fn, void *cb_data); |
126c1cce HW |
327 | |
328 | /** | |
329 | * iterates all refs which have a defined prefix and strips that prefix from | |
330 | * the passed variable refname. | |
331 | */ | |
1354c9b2 | 332 | int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data); |
126c1cce | 333 | |
073cf63c NTND |
334 | int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix, |
335 | each_ref_fn fn, void *cb_data, | |
336 | unsigned int broken); | |
1354c9b2 MH |
337 | int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, |
338 | unsigned int broken); | |
126c1cce HW |
339 | |
340 | /** | |
341 | * iterate refs from the respective area. | |
342 | */ | |
1354c9b2 MH |
343 | int for_each_tag_ref(each_ref_fn fn, void *cb_data); |
344 | int for_each_branch_ref(each_ref_fn fn, void *cb_data); | |
345 | int for_each_remote_ref(each_ref_fn fn, void *cb_data); | |
212e0f7e | 346 | int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data); |
126c1cce HW |
347 | |
348 | /* iterates all refs that match the specified glob pattern. */ | |
1354c9b2 | 349 | int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data); |
126c1cce | 350 | |
1354c9b2 MH |
351 | int for_each_glob_ref_in(each_ref_fn fn, const char *pattern, |
352 | const char *prefix, void *cb_data); | |
353 | ||
1354c9b2 MH |
354 | int head_ref_namespaced(each_ref_fn fn, void *cb_data); |
355 | int for_each_namespaced_ref(each_ref_fn fn, void *cb_data); | |
a1bea2c1 | 356 | |
fb58c8d5 | 357 | /* can be used to learn about broken ref and symref */ |
7d2df051 | 358 | int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 359 | int for_each_rawref(each_ref_fn fn, void *cb_data); |
fb58c8d5 | 360 | |
65516f58 RA |
361 | /* |
362 | * Normalizes partial refs to their fully qualified form. | |
363 | * Will prepend <prefix> to the <pattern> if it doesn't start with 'refs/'. | |
364 | * <prefix> will default to 'refs/' if NULL. | |
365 | * | |
366 | * item.string will be set to the result. | |
367 | * item.util will be set to NULL if <pattern> contains glob characters, or | |
368 | * non-NULL if it doesn't. | |
369 | */ | |
370 | void normalize_glob_ref(struct string_list_item *item, const char *prefix, | |
371 | const char *pattern); | |
372 | ||
894a9d33 TR |
373 | static inline const char *has_glob_specials(const char *pattern) |
374 | { | |
375 | return strpbrk(pattern, "?*["); | |
376 | } | |
377 | ||
1354c9b2 MH |
378 | void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); |
379 | void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, | |
380 | const struct string_list *refnames); | |
f8948e2f | 381 | |
32d462ce MH |
382 | /* |
383 | * Flags for controlling behaviour of pack_refs() | |
384 | * PACK_REFS_PRUNE: Prune loose refs after packing | |
385 | * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs | |
386 | */ | |
387 | #define PACK_REFS_PRUNE 0x0001 | |
388 | #define PACK_REFS_ALL 0x0002 | |
389 | ||
390 | /* | |
391 | * Write a packed-refs file for the current repository. | |
392 | * flags: Combination of the above PACK_REFS_* flags. | |
393 | */ | |
7d2df051 | 394 | int refs_pack_refs(struct ref_store *refs, unsigned int flags); |
32d462ce | 395 | |
bd3b02da | 396 | /* |
a4c653df | 397 | * Setup reflog before using. Fill in err and return -1 on failure. |
bd3b02da | 398 | */ |
7d2df051 NTND |
399 | int refs_create_reflog(struct ref_store *refs, const char *refname, |
400 | int force_create, struct strbuf *err); | |
abd0cd3a | 401 | int safe_create_reflog(const char *refname, int force_create, struct strbuf *err); |
859c3017 | 402 | |
d556fae2 | 403 | /** Reads log for the value of ref during at_time. **/ |
7fdff474 NTND |
404 | int read_ref_at(struct ref_store *refs, |
405 | const char *refname, unsigned int flags, | |
dddbad72 | 406 | timestamp_t at_time, int cnt, |
8eb36d94 | 407 | struct object_id *oid, char **msg, |
dddbad72 | 408 | timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt); |
d556fae2 | 409 | |
4da58835 | 410 | /** Check if a particular reflog exists */ |
7d2df051 | 411 | int refs_reflog_exists(struct ref_store *refs, const char *refname); |
1354c9b2 | 412 | int reflog_exists(const char *refname); |
4da58835 | 413 | |
fc1c2168 | 414 | /* |
2616a5e5 | 415 | * Delete the specified reference. If old_oid is non-NULL, then |
78fb4579 | 416 | * verify that the current value of the reference is old_oid before |
2616a5e5 | 417 | * deleting it. If old_oid is NULL, delete the reference if it |
418 | * exists, regardless of its old value. It is an error for old_oid to | |
419 | * be null_oid. msg and flags are passed through to | |
64da4199 | 420 | * ref_transaction_delete(). |
fc1c2168 | 421 | */ |
c0fe4e8b NTND |
422 | int refs_delete_ref(struct ref_store *refs, const char *msg, |
423 | const char *refname, | |
2616a5e5 | 424 | const struct object_id *old_oid, |
c0fe4e8b | 425 | unsigned int flags); |
755b49ae | 426 | int delete_ref(const char *msg, const char *refname, |
2616a5e5 | 427 | const struct object_id *old_oid, unsigned int flags); |
fc1c2168 | 428 | |
98ffd5ff MH |
429 | /* |
430 | * Delete the specified references. If there are any problems, emit | |
431 | * errors but attempt to keep going (i.e., the deletes are not done in | |
64da4199 | 432 | * an all-or-nothing transaction). msg and flags are passed through to |
c5f04ddd | 433 | * ref_transaction_delete(). |
98ffd5ff | 434 | */ |
64da4199 MH |
435 | int refs_delete_refs(struct ref_store *refs, const char *msg, |
436 | struct string_list *refnames, unsigned int flags); | |
437 | int delete_refs(const char *msg, struct string_list *refnames, | |
438 | unsigned int flags); | |
98ffd5ff | 439 | |
4da58835 | 440 | /** Delete a reflog */ |
7d2df051 | 441 | int refs_delete_reflog(struct ref_store *refs, const char *refname); |
1354c9b2 | 442 | int delete_reflog(const char *refname); |
4da58835 | 443 | |
d1eb22da HWN |
444 | /* |
445 | * Callback to process a reflog entry found by the iteration functions (see | |
446 | * below) | |
447 | */ | |
1354c9b2 | 448 | typedef int each_reflog_ent_fn( |
9461d272 | 449 | struct object_id *old_oid, struct object_id *new_oid, |
dddbad72 | 450 | const char *committer, timestamp_t timestamp, |
1354c9b2 MH |
451 | int tz, const char *msg, void *cb_data); |
452 | ||
d1eb22da HWN |
453 | /* Iterate over reflog entries in the log for `refname`. */ |
454 | ||
455 | /* oldest entry first */ | |
7d2df051 NTND |
456 | int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname, |
457 | each_reflog_ent_fn fn, void *cb_data); | |
d1eb22da HWN |
458 | |
459 | /* youngest entry first */ | |
7d2df051 NTND |
460 | int refs_for_each_reflog_ent_reverse(struct ref_store *refs, |
461 | const char *refname, | |
462 | each_reflog_ent_fn fn, | |
463 | void *cb_data); | |
d1eb22da HWN |
464 | |
465 | /* | |
466 | * Iterate over reflog entries in the log for `refname` in the main ref store. | |
467 | */ | |
468 | ||
469 | /* oldest entry first */ | |
dfefa935 | 470 | int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
d1eb22da HWN |
471 | |
472 | /* youngest entry first */ | |
98f85ff4 | 473 | int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
2ff81662 | 474 | |
eb8381c8 NP |
475 | /* |
476 | * Calls the specified function for each reflog file until it returns nonzero, | |
adac8115 | 477 | * and returns the value. Reflog file order is unspecified. |
eb8381c8 | 478 | */ |
7d2df051 | 479 | int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 480 | int for_each_reflog(each_ref_fn fn, void *cb_data); |
eb8381c8 | 481 | |
8d9c5010 MH |
482 | #define REFNAME_ALLOW_ONELEVEL 1 |
483 | #define REFNAME_REFSPEC_PATTERN 2 | |
484 | ||
485 | /* | |
dfefa935 MH |
486 | * Return 0 iff refname has the correct format for a refname according |
487 | * to the rules described in Documentation/git-check-ref-format.txt. | |
488 | * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level | |
8d9c5010 | 489 | * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then |
cd377f45 JK |
490 | * allow a single "*" wildcard character in the refspec. No leading or |
491 | * repeated slashes are accepted. | |
8d9c5010 | 492 | */ |
1354c9b2 | 493 | int check_refname_format(const char *refname, int flags); |
95fc7512 | 494 | |
1de16aec NTND |
495 | /* |
496 | * Apply the rules from check_refname_format, but mutate the result until it | |
497 | * is acceptable, and place the result in "out". | |
498 | */ | |
499 | void sanitize_refname_component(const char *refname, struct strbuf *out); | |
500 | ||
1354c9b2 | 501 | const char *prettify_refname(const char *refname); |
fb58c8d5 | 502 | |
546edf37 NTND |
503 | char *refs_shorten_unambiguous_ref(struct ref_store *refs, |
504 | const char *refname, int strict); | |
1354c9b2 | 505 | char *shorten_unambiguous_ref(const char *refname, int strict); |
a9c37a72 | 506 | |
c976d415 | 507 | /** rename ref, return 0 on success **/ |
7d2df051 NTND |
508 | int refs_rename_ref(struct ref_store *refs, const char *oldref, |
509 | const char *newref, const char *logmsg); | |
52d59cc6 SD |
510 | int rename_ref(const char *oldref, const char *newref, |
511 | const char *logmsg); | |
512 | ||
513 | /** copy ref, return 0 on success **/ | |
514 | int refs_copy_existing_ref(struct ref_store *refs, const char *oldref, | |
515 | const char *newref, const char *logmsg); | |
516 | int copy_existing_ref(const char *oldref, const char *newref, | |
517 | const char *logmsg); | |
c976d415 | 518 | |
7d2df051 NTND |
519 | int refs_create_symref(struct ref_store *refs, const char *refname, |
520 | const char *target, const char *logmsg); | |
1354c9b2 | 521 | int create_symref(const char *refname, const char *target, const char *logmsg); |
0ebde32c | 522 | |
f4124112 MH |
523 | enum action_on_err { |
524 | UPDATE_REFS_MSG_ON_ERR, | |
525 | UPDATE_REFS_DIE_ON_ERR, | |
526 | UPDATE_REFS_QUIET_ON_ERR | |
527 | }; | |
528 | ||
caa4046c MH |
529 | /* |
530 | * Begin a reference transaction. The reference transaction must | |
33f9fc59 | 531 | * be freed by calling ref_transaction_free(). |
caa4046c | 532 | */ |
c0fe4e8b NTND |
533 | struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs, |
534 | struct strbuf *err); | |
93a644ea | 535 | struct ref_transaction *ref_transaction_begin(struct strbuf *err); |
caa4046c | 536 | |
caa4046c | 537 | /* |
d1dd721f MH |
538 | * Reference transaction updates |
539 | * | |
540 | * The following four functions add a reference check or update to a | |
541 | * ref_transaction. They have some common similar parameters: | |
542 | * | |
543 | * transaction -- a pointer to an open ref_transaction, obtained | |
544 | * from ref_transaction_begin(). | |
545 | * | |
546 | * refname -- the name of the reference to be affected. | |
547 | * | |
5ac95fee MH |
548 | * new_oid -- the object ID that should be set to be the new value |
549 | * of the reference. Some functions allow this parameter to be | |
fd2ce9c0 | 550 | * NULL, meaning that the reference is not changed, or |
5ac95fee | 551 | * null_oid, meaning that the reference should be deleted. A |
fd2ce9c0 MH |
552 | * copy of this value is made in the transaction. |
553 | * | |
5ac95fee | 554 | * old_oid -- the object ID that the reference must have before |
fd2ce9c0 MH |
555 | * the update. Some functions allow this parameter to be NULL, |
556 | * meaning that the old value of the reference is not checked, | |
5ac95fee | 557 | * or null_oid, meaning that the reference must not exist |
fd2ce9c0 MH |
558 | * before the update. A copy of this value is made in the |
559 | * transaction. | |
560 | * | |
d1dd721f | 561 | * flags -- flags affecting the update, passed to |
91774afc | 562 | * update_ref_lock(). Possible flags: REF_NO_DEREF, |
5ac95fee MH |
563 | * REF_FORCE_CREATE_REFLOG. See those constants for more |
564 | * information. | |
d1dd721f MH |
565 | * |
566 | * msg -- a message describing the change (for the reflog). | |
567 | * | |
568 | * err -- a strbuf for receiving a description of any error that | |
dc72b500 | 569 | * might have occurred. |
d1dd721f MH |
570 | * |
571 | * The functions make internal copies of refname and msg, so the | |
572 | * caller retains ownership of these parameters. | |
573 | * | |
574 | * The functions return 0 on success and non-zero on failure. A | |
575 | * failure means that the transaction as a whole has failed and needs | |
576 | * to be rolled back. | |
caa4046c MH |
577 | */ |
578 | ||
caa4046c | 579 | /* |
5ac95fee MH |
580 | * The following flags can be passed to ref_transaction_update() etc. |
581 | * Internally, they are stored in `ref_update::flags`, along with some | |
582 | * internal flags. | |
583 | */ | |
584 | ||
585 | /* | |
586 | * Act on the ref directly; i.e., without dereferencing symbolic refs. | |
587 | * If this flag is not specified, then symbolic references are | |
588 | * dereferenced and the update is applied to the referent. | |
589 | */ | |
91774afc | 590 | #define REF_NO_DEREF (1 << 0) |
5ac95fee MH |
591 | |
592 | /* | |
593 | * Force the creation of a reflog for this reference, even if it | |
594 | * didn't previously have a reflog. | |
595 | */ | |
596 | #define REF_FORCE_CREATE_REFLOG (1 << 1) | |
597 | ||
598 | /* | |
599 | * Bitmask of all of the flags that are allowed to be passed in to | |
600 | * ref_transaction_update() and friends: | |
601 | */ | |
602 | #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \ | |
91774afc | 603 | (REF_NO_DEREF | REF_FORCE_CREATE_REFLOG) |
5ac95fee MH |
604 | |
605 | /* | |
606 | * Add a reference update to transaction. `new_oid` is the value that | |
607 | * the reference should have after the update, or `null_oid` if it | |
608 | * should be deleted. If `new_oid` is NULL, then the reference is not | |
609 | * changed at all. `old_oid` is the value that the reference must have | |
610 | * before the update, or `null_oid` if it must not have existed | |
16180334 | 611 | * beforehand. The old value is checked after the lock is taken to |
89f3bbdd | 612 | * prevent races. If the old value doesn't agree with old_oid, the |
613 | * whole transaction fails. If old_oid is NULL, then the previous | |
16180334 MH |
614 | * value is not checked. |
615 | * | |
d1dd721f MH |
616 | * See the above comment "Reference transaction updates" for more |
617 | * information. | |
caa4046c | 618 | */ |
8e34800e RS |
619 | int ref_transaction_update(struct ref_transaction *transaction, |
620 | const char *refname, | |
89f3bbdd | 621 | const struct object_id *new_oid, |
622 | const struct object_id *old_oid, | |
1d147bdf | 623 | unsigned int flags, const char *msg, |
8e34800e | 624 | struct strbuf *err); |
caa4046c MH |
625 | |
626 | /* | |
89f3bbdd | 627 | * Add a reference creation to transaction. new_oid is the value that |
d1dd721f | 628 | * the reference should have after the update; it must not be |
89f3bbdd | 629 | * null_oid. It is verified that the reference does not exist |
caa4046c | 630 | * already. |
d1dd721f MH |
631 | * |
632 | * See the above comment "Reference transaction updates" for more | |
633 | * information. | |
caa4046c | 634 | */ |
b416af5b RS |
635 | int ref_transaction_create(struct ref_transaction *transaction, |
636 | const char *refname, | |
89f3bbdd | 637 | const struct object_id *new_oid, |
fec14ec3 | 638 | unsigned int flags, const char *msg, |
b416af5b | 639 | struct strbuf *err); |
caa4046c MH |
640 | |
641 | /* | |
89f3bbdd | 642 | * Add a reference deletion to transaction. If old_oid is non-NULL, |
d1dd721f | 643 | * then it holds the value that the reference should have had before |
89f3bbdd | 644 | * the update (which must not be null_oid). |
d1dd721f MH |
645 | * |
646 | * See the above comment "Reference transaction updates" for more | |
647 | * information. | |
caa4046c | 648 | */ |
8c8bdc0d RS |
649 | int ref_transaction_delete(struct ref_transaction *transaction, |
650 | const char *refname, | |
89f3bbdd | 651 | const struct object_id *old_oid, |
fb5a6bb6 | 652 | unsigned int flags, const char *msg, |
8c8bdc0d | 653 | struct strbuf *err); |
caa4046c | 654 | |
16180334 | 655 | /* |
89f3bbdd | 656 | * Verify, within a transaction, that refname has the value old_oid, |
657 | * or, if old_oid is null_oid, then verify that the reference | |
658 | * doesn't exist. old_oid must be non-NULL. | |
d1dd721f MH |
659 | * |
660 | * See the above comment "Reference transaction updates" for more | |
661 | * information. | |
16180334 MH |
662 | */ |
663 | int ref_transaction_verify(struct ref_transaction *transaction, | |
664 | const char *refname, | |
89f3bbdd | 665 | const struct object_id *old_oid, |
16180334 MH |
666 | unsigned int flags, |
667 | struct strbuf *err); | |
668 | ||
28e6a97e RS |
669 | /* Naming conflict (for example, the ref names A and A/B conflict). */ |
670 | #define TRANSACTION_NAME_CONFLICT -1 | |
671 | /* All other errors. */ | |
672 | #define TRANSACTION_GENERIC_ERROR -2 | |
30173b88 MH |
673 | |
674 | /* | |
64127575 | 675 | * Perform the preparatory stages of committing `transaction`. Acquire |
30173b88 MH |
676 | * any needed locks, check preconditions, etc.; basically, do as much |
677 | * as possible to ensure that the transaction will be able to go | |
678 | * through, stopping just short of making any irrevocable or | |
679 | * user-visible changes. The updates that this function prepares can | |
680 | * be finished up by calling `ref_transaction_commit()` or rolled back | |
681 | * by calling `ref_transaction_abort()`. | |
682 | * | |
683 | * On success, return 0 and leave the transaction in "prepared" state. | |
684 | * On failure, abort the transaction, write an error message to `err`, | |
685 | * and return one of the `TRANSACTION_*` constants. | |
686 | * | |
64127575 | 687 | * Callers who don't need such fine-grained control over committing |
30173b88 MH |
688 | * reference transactions should just call `ref_transaction_commit()`. |
689 | */ | |
690 | int ref_transaction_prepare(struct ref_transaction *transaction, | |
691 | struct strbuf *err); | |
692 | ||
693 | /* | |
694 | * Commit all of the changes that have been queued in transaction, as | |
695 | * atomically as possible. On success, return 0 and leave the | |
696 | * transaction in "closed" state. On failure, roll back the | |
697 | * transaction, write an error message to `err`, and return one of the | |
698 | * `TRANSACTION_*` constants | |
699 | */ | |
caa4046c | 700 | int ref_transaction_commit(struct ref_transaction *transaction, |
db7516ab | 701 | struct strbuf *err); |
caa4046c | 702 | |
30173b88 MH |
703 | /* |
704 | * Abort `transaction`, which has been begun and possibly prepared, | |
705 | * but not yet committed. | |
706 | */ | |
707 | int ref_transaction_abort(struct ref_transaction *transaction, | |
708 | struct strbuf *err); | |
709 | ||
58f233ce MH |
710 | /* |
711 | * Like ref_transaction_commit(), but optimized for creating | |
712 | * references when originally initializing a repository (e.g., by "git | |
713 | * clone"). It writes the new references directly to packed-refs | |
714 | * without locking the individual references. | |
715 | * | |
716 | * It is a bug to call this function when there might be other | |
717 | * processes accessing the repository or if there are existing | |
718 | * references that might conflict with the ones being created. All | |
78fb4579 | 719 | * old_oid values must either be absent or null_oid. |
58f233ce MH |
720 | */ |
721 | int initial_ref_transaction_commit(struct ref_transaction *transaction, | |
722 | struct strbuf *err); | |
723 | ||
026bd1d3 | 724 | /* |
30173b88 | 725 | * Free `*transaction` and all associated data. |
026bd1d3 RS |
726 | */ |
727 | void ref_transaction_free(struct ref_transaction *transaction); | |
728 | ||
4b7b520b MH |
729 | /** |
730 | * Lock, update, and unlock a single reference. This function | |
731 | * basically does a transaction containing a single call to | |
732 | * ref_transaction_update(). The parameters to this function have the | |
733 | * same meaning as the corresponding parameters to | |
734 | * ref_transaction_update(). Handle errors as requested by the `onerr` | |
735 | * argument. | |
736 | */ | |
c0fe4e8b | 737 | int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname, |
ae077771 | 738 | const struct object_id *new_oid, const struct object_id *old_oid, |
c0fe4e8b | 739 | unsigned int flags, enum action_on_err onerr); |
4b7b520b | 740 | int update_ref(const char *msg, const char *refname, |
8f6dc7e3 | 741 | const struct object_id *new_oid, const struct object_id *old_oid, |
742 | unsigned int flags, enum action_on_err onerr); | |
3d9f037c | 743 | |
1354c9b2 | 744 | int parse_hide_refs_config(const char *var, const char *value, const char *); |
fb58c8d5 | 745 | |
78a766ab LF |
746 | /* |
747 | * Check whether a ref is hidden. If no namespace is set, both the first and | |
748 | * the second parameter point to the full ref name. If a namespace is set and | |
749 | * the ref is inside that namespace, the first parameter is a pointer to the | |
750 | * name of the ref with the namespace prefix removed. If a namespace is set and | |
751 | * the ref is outside that namespace, the first parameter is NULL. The second | |
752 | * parameter always points to the full ref name. | |
753 | */ | |
1354c9b2 | 754 | int ref_is_hidden(const char *, const char *); |
daebaa78 | 755 | |
266b1827 | 756 | enum ref_type { |
3a3b9d8c NTND |
757 | REF_TYPE_PER_WORKTREE, /* refs inside refs/ but not shared */ |
758 | REF_TYPE_PSEUDOREF, /* refs outside refs/ in current worktree */ | |
759 | REF_TYPE_MAIN_PSEUDOREF, /* pseudo refs from the main worktree */ | |
760 | REF_TYPE_OTHER_PSEUDOREF, /* pseudo refs from other worktrees */ | |
761 | REF_TYPE_NORMAL, /* normal/shared refs inside refs/ */ | |
266b1827 DT |
762 | }; |
763 | ||
764 | enum ref_type ref_type(const char *refname); | |
765 | ||
fa5b1830 MH |
766 | enum expire_reflog_flags { |
767 | EXPIRE_REFLOGS_DRY_RUN = 1 << 0, | |
768 | EXPIRE_REFLOGS_UPDATE_REF = 1 << 1, | |
769 | EXPIRE_REFLOGS_VERBOSE = 1 << 2, | |
770 | EXPIRE_REFLOGS_REWRITE = 1 << 3 | |
771 | }; | |
772 | ||
773 | /* | |
774 | * The following interface is used for reflog expiration. The caller | |
775 | * calls reflog_expire(), supplying it with three callback functions, | |
776 | * of the following types. The callback functions define the | |
777 | * expiration policy that is desired. | |
778 | * | |
779 | * reflog_expiry_prepare_fn -- Called once after the reference is | |
780 | * locked. | |
781 | * | |
782 | * reflog_expiry_should_prune_fn -- Called once for each entry in the | |
783 | * existing reflog. It should return true iff that entry should be | |
784 | * pruned. | |
785 | * | |
786 | * reflog_expiry_cleanup_fn -- Called once before the reference is | |
787 | * unlocked again. | |
788 | */ | |
789 | typedef void reflog_expiry_prepare_fn(const char *refname, | |
4322478a | 790 | const struct object_id *oid, |
fa5b1830 | 791 | void *cb_data); |
4322478a | 792 | typedef int reflog_expiry_should_prune_fn(struct object_id *ooid, |
793 | struct object_id *noid, | |
fa5b1830 | 794 | const char *email, |
dddbad72 | 795 | timestamp_t timestamp, int tz, |
fa5b1830 MH |
796 | const char *message, void *cb_data); |
797 | typedef void reflog_expiry_cleanup_fn(void *cb_data); | |
798 | ||
799 | /* | |
0155f710 | 800 | * Expire reflog entries for the specified reference. oid is the old |
fa5b1830 MH |
801 | * value of the reference. flags is a combination of the constants in |
802 | * enum expire_reflog_flags. The three function pointers are described | |
803 | * above. On success, return zero. | |
804 | */ | |
7d2df051 NTND |
805 | int refs_reflog_expire(struct ref_store *refs, |
806 | const char *refname, | |
0155f710 | 807 | const struct object_id *oid, |
7d2df051 NTND |
808 | unsigned int flags, |
809 | reflog_expiry_prepare_fn prepare_fn, | |
810 | reflog_expiry_should_prune_fn should_prune_fn, | |
811 | reflog_expiry_cleanup_fn cleanup_fn, | |
812 | void *policy_cb_data); | |
0155f710 | 813 | int reflog_expire(const char *refname, const struct object_id *oid, |
1354c9b2 MH |
814 | unsigned int flags, |
815 | reflog_expiry_prepare_fn prepare_fn, | |
816 | reflog_expiry_should_prune_fn should_prune_fn, | |
817 | reflog_expiry_cleanup_fn cleanup_fn, | |
818 | void *policy_cb_data); | |
fa5b1830 | 819 | |
3dce444f RS |
820 | int ref_storage_backend_exists(const char *name); |
821 | ||
64a74161 | 822 | struct ref_store *get_main_ref_store(struct repository *r); |
126c1cce HW |
823 | |
824 | /** | |
825 | * Submodules | |
826 | * ---------- | |
827 | * | |
828 | * If you want to iterate the refs of a submodule you first need to add the | |
829 | * submodules object database. You can do this by a code-snippet like | |
830 | * this: | |
831 | * | |
832 | * const char *path = "path/to/submodule" | |
833 | * if (add_submodule_odb(path)) | |
834 | * die("Error submodule '%s' not populated.", path); | |
835 | * | |
836 | * `add_submodule_odb()` will return zero on success. If you | |
837 | * do not do this you will get an error for each ref that it does not point | |
838 | * to a valid object. | |
839 | * | |
840 | * Note: As a side-effect of this you cannot safely assume that all | |
841 | * objects you lookup are available in superproject. All submodule objects | |
842 | * will be available the same way as the superprojects objects. | |
843 | * | |
844 | * Example: | |
845 | * -------- | |
846 | * | |
847 | * ---- | |
848 | * static int handle_remote_ref(const char *refname, | |
849 | * const unsigned char *sha1, int flags, void *cb_data) | |
850 | * { | |
851 | * struct strbuf *output = cb_data; | |
852 | * strbuf_addf(output, "%s\n", refname); | |
853 | * return 0; | |
854 | * } | |
855 | * | |
856 | */ | |
857 | ||
18d0002d NTND |
858 | /* |
859 | * Return the ref_store instance for the specified submodule. For the | |
860 | * main repository, use submodule==NULL; such a call cannot fail. For | |
861 | * a submodule, the submodule must exist and be a nonbare repository, | |
862 | * otherwise return NULL. If the requested reference store has not yet | |
863 | * been initialized, initialize it first. | |
864 | * | |
865 | * For backwards compatibility, submodule=="" is treated the same as | |
866 | * submodule==NULL. | |
867 | */ | |
868 | struct ref_store *get_submodule_ref_store(const char *submodule); | |
17eff96b | 869 | struct ref_store *get_worktree_ref_store(const struct worktree *wt); |
077be78d | 870 | |
95fc7512 | 871 | #endif /* REFS_H */ |