struct ref_entry: document name member
[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
98ac34b2
JH
13#define REF_ISSYMREF 0x01
14#define REF_ISPACKED 0x02
15#define REF_ISBROKEN 0x04
f4204ab9 16
8a65ff76
LT
17/*
18 * Calls the specified function for each ref file until it returns nonzero,
19 * and returns the value
20 */
8da19775 21typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
cb5d709f
JH
22extern int head_ref(each_ref_fn, void *);
23extern int for_each_ref(each_ref_fn, void *);
2a8177b6 24extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
25extern int for_each_tag_ref(each_ref_fn, void *);
26extern int for_each_branch_ref(each_ref_fn, void *);
27extern int for_each_remote_ref(each_ref_fn, void *);
29268700 28extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 29extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 30extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 31
9ef6aeb0
HV
32extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
33extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
34extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
35 each_ref_fn fn, void *cb_data);
36extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
37extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
38extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
39
a1bea2c1
JT
40extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
41extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
42
894a9d33
TR
43static inline const char *has_glob_specials(const char *pattern)
44{
45 return strpbrk(pattern, "?*[");
46}
47
f8948e2f
JH
48/* can be used to learn about broken ref and symref */
49extern int for_each_rawref(each_ref_fn, void *);
50
3cf6134a 51extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
f8948e2f 52
e142a3c6
DB
53/*
54 * Extra refs will be listed by for_each_ref() before any actual refs
55 * for the duration of this process or until clear_extra_refs() is
56 * called. Only extra refs added before for_each_ref() is called will
57 * be listed on a given call of for_each_ref().
58 */
59extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
60extern void clear_extra_refs(void);
2c5c66be 61extern int ref_exists(const char *);
e142a3c6 62
cf0adba7
JH
63extern int peel_ref(const char *, unsigned char *);
64
4bd18c43 65/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
4431fcc4 66extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
4bd18c43
SP
67
68/** Locks any ref (for 'HEAD' type refs). */
68db31cc
SV
69#define REF_NODEREF 0x01
70extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
95fc7512 71
435fc852
BC
72/** Close the file descriptor owned by a lock and return the status */
73extern int close_ref(struct ref_lock *lock);
74
75/** Close and commit the ref locked by the lock */
76extern int commit_ref(struct ref_lock *lock);
77
4bd18c43 78/** Release any lock taken but not written. **/
e5f38ec3 79extern void unlock_ref(struct ref_lock *lock);
95fc7512 80
4bd18c43
SP
81/** Writes sha1 into the ref specified by the lock. **/
82extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 83
8be8bde7
MH
84/*
85 * Invalidate the reference cache for the specified submodule. Use
86 * submodule=NULL to invalidate the cache for the main module. This
87 * function must be called if references are changed via a mechanism
88 * other than the refs API.
89 */
90extern void invalidate_ref_cache(const char *submodule);
91
859c3017 92/** Setup reflog before using. **/
157aaea5 93int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
859c3017 94
d556fae2 95/** Reads log for the value of ref during at_time. **/
16d7cc90 96extern int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1, char **msg, unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 97
2ff81662 98/* iterate over reflog entries */
883d60fa
JS
99typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
100int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
101d15e0 101int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data);
2ff81662 102
eb8381c8
NP
103/*
104 * Calls the specified function for each reflog file until it returns nonzero,
105 * and returns the value
106 */
107extern int for_each_reflog(each_ref_fn, void *);
108
8d9c5010
MH
109#define REFNAME_ALLOW_ONELEVEL 1
110#define REFNAME_REFSPEC_PATTERN 2
dce4bab6 111#define REFNAME_DOT_COMPONENT 4
8d9c5010
MH
112
113/*
114 * Return 0 iff ref has the correct format for a refname according to
115 * the rules described in Documentation/git-check-ref-format.txt. If
116 * REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
117 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
118 * allow a "*" wildcard character in place of one of the name
dce4bab6
MH
119 * components. No leading or repeated slashes are accepted. If
120 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
121 * components to start with "." (but not a whole component equal to
122 * "." or "..").
8d9c5010
MH
123 */
124extern int check_refname_format(const char *ref, int flags);
95fc7512 125
4577e483 126extern const char *prettify_refname(const char *refname);
6e7b3309 127extern char *shorten_unambiguous_ref(const char *ref, int strict);
a9c37a72 128
c976d415 129/** rename ref, return 0 on success **/
678d0f4c 130extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 131
0ebde32c
LT
132/** resolve ref in nested "gitlink" repository */
133extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
134
3d9f037c
CR
135/** lock a ref and then write its file */
136enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
137int update_ref(const char *action, const char *refname,
138 const unsigned char *sha1, const unsigned char *oldval,
139 int flags, enum action_on_err onerr);
140
95fc7512 141#endif /* REFS_H */