stash: teach 'push' (and 'create_stash') to honor pathspec
[git.git] / refs.h
blob69478439137d64f6dab7f20d4f157f6c7a982ac2
1 #ifndef REFS_H
2 #define REFS_H
4 /*
5 * Resolve a reference, recursively following symbolic refererences.
7 * Store the referred-to object's name in sha1 and return the name of
8 * the non-symbolic reference that ultimately pointed at it. The
9 * return value, if not NULL, is a pointer into either a static buffer
10 * or the input ref.
12 * If the reference cannot be resolved to an object, the behavior
13 * depends on the RESOLVE_REF_READING flag:
15 * - If RESOLVE_REF_READING is set, return NULL.
17 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
18 * the last reference name in the chain, which will either be a non-symbolic
19 * reference or an undefined reference. If this is a prelude to
20 * "writing" to the ref, the return value is the name of the ref
21 * that will actually be created or changed.
23 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
24 * level of symbolic reference. The value stored in sha1 for a symbolic
25 * reference will always be null_sha1 in this case, and the return
26 * value is the reference that the symref refers to directly.
28 * If flags is non-NULL, set the value that it points to the
29 * combination of REF_ISPACKED (if the reference was found among the
30 * packed references), REF_ISSYMREF (if the initial reference was a
31 * symbolic reference), REF_BAD_NAME (if the reference name is ill
32 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
33 * (if the ref is malformed or has a bad name). See refs.h for more detail
34 * on each flag.
36 * If ref is not a properly-formatted, normalized reference, return
37 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
38 * give up and return NULL.
40 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
41 * name is invalid according to git-check-ref-format(1). If the name
42 * is bad then the value stored in sha1 will be null_sha1 and the two
43 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
45 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
46 * directory and do not consist of all caps and underscores cannot be
47 * resolved. The function returns NULL for such ref names.
48 * Caps and underscores refers to the special refs, such as HEAD,
49 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
51 #define RESOLVE_REF_READING 0x01
52 #define RESOLVE_REF_NO_RECURSE 0x02
53 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
55 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
56 unsigned char *sha1, int *flags);
58 char *resolve_refdup(const char *refname, int resolve_flags,
59 unsigned char *sha1, int *flags);
61 int read_ref_full(const char *refname, int resolve_flags,
62 unsigned char *sha1, int *flags);
63 int read_ref(const char *refname, unsigned char *sha1);
65 int ref_exists(const char *refname);
67 int is_branch(const char *refname);
69 extern int refs_init_db(struct strbuf *err);
72 * If refname is a non-symbolic reference that refers to a tag object,
73 * and the tag can be (recursively) dereferenced to a non-tag object,
74 * store the SHA1 of the referred-to object to sha1 and return 0. If
75 * any of these conditions are not met, return a non-zero value.
76 * Symbolic references are considered unpeelable, even if they
77 * ultimately resolve to a peelable tag.
79 int peel_ref(const char *refname, unsigned char *sha1);
81 /**
82 * Resolve refname in the nested "gitlink" repository in the specified
83 * submodule (which must be non-NULL). If the resolution is
84 * successful, return 0 and set sha1 to the name of the object;
85 * otherwise, return a non-zero value.
87 int resolve_gitlink_ref(const char *submodule, const char *refname,
88 unsigned char *sha1);
91 * Return true iff abbrev_name is a possible abbreviation for
92 * full_name according to the rules defined by ref_rev_parse_rules in
93 * refs.c.
95 int refname_match(const char *abbrev_name, const char *full_name);
97 int expand_ref(const char *str, int len, unsigned char *sha1, char **ref);
98 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
99 int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
102 * A ref_transaction represents a collection of ref updates
103 * that should succeed or fail together.
105 * Calling sequence
106 * ----------------
107 * - Allocate and initialize a `struct ref_transaction` by calling
108 * `ref_transaction_begin()`.
110 * - List intended ref updates by calling functions like
111 * `ref_transaction_update()` and `ref_transaction_create()`.
113 * - Call `ref_transaction_commit()` to execute the transaction.
114 * If this succeeds, the ref updates will have taken place and
115 * the transaction cannot be rolled back.
117 * - Instead of `ref_transaction_commit`, use
118 * `initial_ref_transaction_commit()` if the ref database is known
119 * to be empty (e.g. during clone). This is likely to be much
120 * faster.
122 * - At any time call `ref_transaction_free()` to discard the
123 * transaction and free associated resources. In particular,
124 * this rolls back the transaction if it has not been
125 * successfully committed.
127 * Error handling
128 * --------------
130 * On error, transaction functions append a message about what
131 * went wrong to the 'err' argument. The message mentions what
132 * ref was being updated (if any) when the error occurred so it
133 * can be passed to 'die' or 'error' as-is.
135 * The message is appended to err without first clearing err.
136 * err will not be '\n' terminated.
138 * Caveats
139 * -------
141 * Note that no locks are taken, and no refs are read, until
142 * `ref_transaction_commit` is called. So `ref_transaction_verify`
143 * won't report a verification failure until the commit is attempted.
145 struct ref_transaction;
148 * Bit values set in the flags argument passed to each_ref_fn() and
149 * stored in ref_iterator::flags. Other bits are for internal use
150 * only:
153 /* Reference is a symbolic reference. */
154 #define REF_ISSYMREF 0x01
156 /* Reference is a packed reference. */
157 #define REF_ISPACKED 0x02
160 * Reference cannot be resolved to an object name: dangling symbolic
161 * reference (directly or indirectly), corrupt reference file,
162 * reference exists but name is bad, or symbolic reference refers to
163 * ill-formatted reference name.
165 #define REF_ISBROKEN 0x04
168 * Reference name is not well formed.
170 * See git-check-ref-format(1) for the definition of well formed ref names.
172 #define REF_BAD_NAME 0x08
175 * The signature for the callback function for the for_each_*()
176 * functions below. The memory pointed to by the refname and sha1
177 * arguments is only guaranteed to be valid for the duration of a
178 * single callback invocation.
180 typedef int each_ref_fn(const char *refname,
181 const struct object_id *oid, int flags, void *cb_data);
184 * The following functions invoke the specified callback function for
185 * each reference indicated. If the function ever returns a nonzero
186 * value, stop the iteration and return that value. Please note that
187 * it is not safe to modify references while an iteration is in
188 * progress, unless the same callback function invocation that
189 * modifies the reference also returns a nonzero value to immediately
190 * stop the iteration.
192 int head_ref(each_ref_fn fn, void *cb_data);
193 int for_each_ref(each_ref_fn fn, void *cb_data);
194 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data);
195 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data,
196 unsigned int broken);
197 int for_each_tag_ref(each_ref_fn fn, void *cb_data);
198 int for_each_branch_ref(each_ref_fn fn, void *cb_data);
199 int for_each_remote_ref(each_ref_fn fn, void *cb_data);
200 int for_each_replace_ref(each_ref_fn fn, void *cb_data);
201 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data);
202 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
203 const char *prefix, void *cb_data);
205 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
206 int for_each_ref_submodule(const char *submodule,
207 each_ref_fn fn, void *cb_data);
208 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
209 each_ref_fn fn, void *cb_data);
210 int for_each_tag_ref_submodule(const char *submodule,
211 each_ref_fn fn, void *cb_data);
212 int for_each_branch_ref_submodule(const char *submodule,
213 each_ref_fn fn, void *cb_data);
214 int for_each_remote_ref_submodule(const char *submodule,
215 each_ref_fn fn, void *cb_data);
217 int head_ref_namespaced(each_ref_fn fn, void *cb_data);
218 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
220 /* can be used to learn about broken ref and symref */
221 int for_each_rawref(each_ref_fn fn, void *cb_data);
223 static inline const char *has_glob_specials(const char *pattern)
225 return strpbrk(pattern, "?*[");
228 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
229 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt,
230 const struct string_list *refnames);
233 * Flags for controlling behaviour of pack_refs()
234 * PACK_REFS_PRUNE: Prune loose refs after packing
235 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
237 #define PACK_REFS_PRUNE 0x0001
238 #define PACK_REFS_ALL 0x0002
241 * Write a packed-refs file for the current repository.
242 * flags: Combination of the above PACK_REFS_* flags.
244 int pack_refs(unsigned int flags);
247 * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
248 * REF_NODEREF: act on the ref directly, instead of dereferencing
249 * symbolic references.
251 * Other flags are reserved for internal use.
253 #define REF_NODEREF 0x01
254 #define REF_FORCE_CREATE_REFLOG 0x40
257 * Setup reflog before using. Fill in err and return -1 on failure.
259 int safe_create_reflog(const char *refname, int force_create, struct strbuf *err);
261 /** Reads log for the value of ref during at_time. **/
262 int read_ref_at(const char *refname, unsigned int flags,
263 unsigned long at_time, int cnt,
264 unsigned char *sha1, char **msg,
265 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
267 /** Check if a particular reflog exists */
268 int reflog_exists(const char *refname);
271 * Delete the specified reference. If old_sha1 is non-NULL, then
272 * verify that the current value of the reference is old_sha1 before
273 * deleting it. If old_sha1 is NULL, delete the reference if it
274 * exists, regardless of its old value. It is an error for old_sha1 to
275 * be NULL_SHA1. flags is passed through to ref_transaction_delete().
277 int delete_ref(const char *refname, const unsigned char *old_sha1,
278 unsigned int flags);
281 * Delete the specified references. If there are any problems, emit
282 * errors but attempt to keep going (i.e., the deletes are not done in
283 * an all-or-nothing transaction). flags is passed through to
284 * ref_transaction_delete().
286 int delete_refs(struct string_list *refnames, unsigned int flags);
288 /** Delete a reflog */
289 int delete_reflog(const char *refname);
291 /* iterate over reflog entries */
292 typedef int each_reflog_ent_fn(
293 unsigned char *old_sha1, unsigned char *new_sha1,
294 const char *committer, unsigned long timestamp,
295 int tz, const char *msg, void *cb_data);
297 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
298 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
301 * Calls the specified function for each reflog file until it returns nonzero,
302 * and returns the value
304 int for_each_reflog(each_ref_fn fn, void *cb_data);
306 #define REFNAME_ALLOW_ONELEVEL 1
307 #define REFNAME_REFSPEC_PATTERN 2
310 * Return 0 iff refname has the correct format for a refname according
311 * to the rules described in Documentation/git-check-ref-format.txt.
312 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
313 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
314 * allow a single "*" wildcard character in the refspec. No leading or
315 * repeated slashes are accepted.
317 int check_refname_format(const char *refname, int flags);
319 const char *prettify_refname(const char *refname);
321 char *shorten_unambiguous_ref(const char *refname, int strict);
323 /** rename ref, return 0 on success **/
324 int rename_ref(const char *oldref, const char *newref, const char *logmsg);
326 int create_symref(const char *refname, const char *target, const char *logmsg);
329 * Update HEAD of the specified gitdir.
330 * Similar to create_symref("relative-git-dir/HEAD", target, NULL), but
331 * this can update the main working tree's HEAD regardless of where
332 * $GIT_DIR points to.
333 * Return 0 if successful, non-zero otherwise.
334 * */
335 int set_worktree_head_symref(const char *gitdir, const char *target);
337 enum action_on_err {
338 UPDATE_REFS_MSG_ON_ERR,
339 UPDATE_REFS_DIE_ON_ERR,
340 UPDATE_REFS_QUIET_ON_ERR
344 * Begin a reference transaction. The reference transaction must
345 * be freed by calling ref_transaction_free().
347 struct ref_transaction *ref_transaction_begin(struct strbuf *err);
350 * Reference transaction updates
352 * The following four functions add a reference check or update to a
353 * ref_transaction. They have some common similar parameters:
355 * transaction -- a pointer to an open ref_transaction, obtained
356 * from ref_transaction_begin().
358 * refname -- the name of the reference to be affected.
360 * flags -- flags affecting the update, passed to
361 * update_ref_lock(). Can be REF_NODEREF, which means that
362 * symbolic references should not be followed.
364 * msg -- a message describing the change (for the reflog).
366 * err -- a strbuf for receiving a description of any error that
367 * might have occurred.
369 * The functions make internal copies of refname and msg, so the
370 * caller retains ownership of these parameters.
372 * The functions return 0 on success and non-zero on failure. A
373 * failure means that the transaction as a whole has failed and needs
374 * to be rolled back.
378 * Add a reference update to transaction. new_sha1 is the value that
379 * the reference should have after the update, or null_sha1 if it
380 * should be deleted. If new_sha1 is NULL, then the reference is not
381 * changed at all. old_sha1 is the value that the reference must have
382 * before the update, or null_sha1 if it must not have existed
383 * beforehand. The old value is checked after the lock is taken to
384 * prevent races. If the old value doesn't agree with old_sha1, the
385 * whole transaction fails. If old_sha1 is NULL, then the previous
386 * value is not checked.
388 * See the above comment "Reference transaction updates" for more
389 * information.
391 int ref_transaction_update(struct ref_transaction *transaction,
392 const char *refname,
393 const unsigned char *new_sha1,
394 const unsigned char *old_sha1,
395 unsigned int flags, const char *msg,
396 struct strbuf *err);
399 * Add a reference creation to transaction. new_sha1 is the value that
400 * the reference should have after the update; it must not be
401 * null_sha1. It is verified that the reference does not exist
402 * already.
404 * See the above comment "Reference transaction updates" for more
405 * information.
407 int ref_transaction_create(struct ref_transaction *transaction,
408 const char *refname,
409 const unsigned char *new_sha1,
410 unsigned int flags, const char *msg,
411 struct strbuf *err);
414 * Add a reference deletion to transaction. If old_sha1 is non-NULL,
415 * then it holds the value that the reference should have had before
416 * the update (which must not be null_sha1).
418 * See the above comment "Reference transaction updates" for more
419 * information.
421 int ref_transaction_delete(struct ref_transaction *transaction,
422 const char *refname,
423 const unsigned char *old_sha1,
424 unsigned int flags, const char *msg,
425 struct strbuf *err);
428 * Verify, within a transaction, that refname has the value old_sha1,
429 * or, if old_sha1 is null_sha1, then verify that the reference
430 * doesn't exist. old_sha1 must be non-NULL.
432 * See the above comment "Reference transaction updates" for more
433 * information.
435 int ref_transaction_verify(struct ref_transaction *transaction,
436 const char *refname,
437 const unsigned char *old_sha1,
438 unsigned int flags,
439 struct strbuf *err);
442 * Commit all of the changes that have been queued in transaction, as
443 * atomically as possible.
445 * Returns 0 for success, or one of the below error codes for errors.
447 /* Naming conflict (for example, the ref names A and A/B conflict). */
448 #define TRANSACTION_NAME_CONFLICT -1
449 /* All other errors. */
450 #define TRANSACTION_GENERIC_ERROR -2
451 int ref_transaction_commit(struct ref_transaction *transaction,
452 struct strbuf *err);
455 * Like ref_transaction_commit(), but optimized for creating
456 * references when originally initializing a repository (e.g., by "git
457 * clone"). It writes the new references directly to packed-refs
458 * without locking the individual references.
460 * It is a bug to call this function when there might be other
461 * processes accessing the repository or if there are existing
462 * references that might conflict with the ones being created. All
463 * old_sha1 values must either be absent or NULL_SHA1.
465 int initial_ref_transaction_commit(struct ref_transaction *transaction,
466 struct strbuf *err);
469 * Free an existing transaction and all associated data.
471 void ref_transaction_free(struct ref_transaction *transaction);
474 * Lock, update, and unlock a single reference. This function
475 * basically does a transaction containing a single call to
476 * ref_transaction_update(). The parameters to this function have the
477 * same meaning as the corresponding parameters to
478 * ref_transaction_update(). Handle errors as requested by the `onerr`
479 * argument.
481 int update_ref(const char *msg, const char *refname,
482 const unsigned char *new_sha1, const unsigned char *old_sha1,
483 unsigned int flags, enum action_on_err onerr);
484 int update_ref_oid(const char *msg, const char *refname,
485 const struct object_id *new_oid, const struct object_id *old_oid,
486 unsigned int flags, enum action_on_err onerr);
488 int parse_hide_refs_config(const char *var, const char *value, const char *);
491 * Check whether a ref is hidden. If no namespace is set, both the first and
492 * the second parameter point to the full ref name. If a namespace is set and
493 * the ref is inside that namespace, the first parameter is a pointer to the
494 * name of the ref with the namespace prefix removed. If a namespace is set and
495 * the ref is outside that namespace, the first parameter is NULL. The second
496 * parameter always points to the full ref name.
498 int ref_is_hidden(const char *, const char *);
500 enum ref_type {
501 REF_TYPE_PER_WORKTREE,
502 REF_TYPE_PSEUDOREF,
503 REF_TYPE_NORMAL,
506 enum ref_type ref_type(const char *refname);
508 enum expire_reflog_flags {
509 EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
510 EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
511 EXPIRE_REFLOGS_VERBOSE = 1 << 2,
512 EXPIRE_REFLOGS_REWRITE = 1 << 3
516 * The following interface is used for reflog expiration. The caller
517 * calls reflog_expire(), supplying it with three callback functions,
518 * of the following types. The callback functions define the
519 * expiration policy that is desired.
521 * reflog_expiry_prepare_fn -- Called once after the reference is
522 * locked.
524 * reflog_expiry_should_prune_fn -- Called once for each entry in the
525 * existing reflog. It should return true iff that entry should be
526 * pruned.
528 * reflog_expiry_cleanup_fn -- Called once before the reference is
529 * unlocked again.
531 typedef void reflog_expiry_prepare_fn(const char *refname,
532 const unsigned char *sha1,
533 void *cb_data);
534 typedef int reflog_expiry_should_prune_fn(unsigned char *osha1,
535 unsigned char *nsha1,
536 const char *email,
537 unsigned long timestamp, int tz,
538 const char *message, void *cb_data);
539 typedef void reflog_expiry_cleanup_fn(void *cb_data);
542 * Expire reflog entries for the specified reference. sha1 is the old
543 * value of the reference. flags is a combination of the constants in
544 * enum expire_reflog_flags. The three function pointers are described
545 * above. On success, return zero.
547 int reflog_expire(const char *refname, const unsigned char *sha1,
548 unsigned int flags,
549 reflog_expiry_prepare_fn prepare_fn,
550 reflog_expiry_should_prune_fn should_prune_fn,
551 reflog_expiry_cleanup_fn cleanup_fn,
552 void *policy_cb_data);
554 int ref_storage_backend_exists(const char *name);
556 #endif /* REFS_H */