struct ref_entry: document name member
[git/git.git] / refs.h
1 #ifndef REFS_H
2 #define REFS_H
3
4 struct ref_lock {
5 char *ref_name;
6 char *orig_ref_name;
7 struct lock_file *lk;
8 unsigned char old_sha1[20];
9 int lock_fd;
10 int force_write;
11 };
12
13 #define REF_ISSYMREF 0x01
14 #define REF_ISPACKED 0x02
15 #define REF_ISBROKEN 0x04
16
17 /*
18 * Calls the specified function for each ref file until it returns nonzero,
19 * and returns the value
20 */
21 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
22 extern int head_ref(each_ref_fn, void *);
23 extern int for_each_ref(each_ref_fn, void *);
24 extern int for_each_ref_in(const char *, each_ref_fn, void *);
25 extern int for_each_tag_ref(each_ref_fn, void *);
26 extern int for_each_branch_ref(each_ref_fn, void *);
27 extern int for_each_remote_ref(each_ref_fn, void *);
28 extern int for_each_replace_ref(each_ref_fn, void *);
29 extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
30 extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
31
32 extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
33 extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
34 extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
35 each_ref_fn fn, void *cb_data);
36 extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
37 extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
38 extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
39
40 extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
41 extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
42
43 static inline const char *has_glob_specials(const char *pattern)
44 {
45 return strpbrk(pattern, "?*[");
46 }
47
48 /* can be used to learn about broken ref and symref */
49 extern int for_each_rawref(each_ref_fn, void *);
50
51 extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
52
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 */
59 extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
60 extern void clear_extra_refs(void);
61 extern int ref_exists(const char *);
62
63 extern int peel_ref(const char *, unsigned char *);
64
65 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
66 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
67
68 /** Locks any ref (for 'HEAD' type refs). */
69 #define REF_NODEREF 0x01
70 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
71
72 /** Close the file descriptor owned by a lock and return the status */
73 extern int close_ref(struct ref_lock *lock);
74
75 /** Close and commit the ref locked by the lock */
76 extern int commit_ref(struct ref_lock *lock);
77
78 /** Release any lock taken but not written. **/
79 extern void unlock_ref(struct ref_lock *lock);
80
81 /** Writes sha1 into the ref specified by the lock. **/
82 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
83
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 */
90 extern void invalidate_ref_cache(const char *submodule);
91
92 /** Setup reflog before using. **/
93 int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
94
95 /** Reads log for the value of ref during at_time. **/
96 extern 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);
97
98 /* iterate over reflog entries */
99 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
100 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
101 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data);
102
103 /*
104 * Calls the specified function for each reflog file until it returns nonzero,
105 * and returns the value
106 */
107 extern int for_each_reflog(each_ref_fn, void *);
108
109 #define REFNAME_ALLOW_ONELEVEL 1
110 #define REFNAME_REFSPEC_PATTERN 2
111 #define REFNAME_DOT_COMPONENT 4
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
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 "..").
123 */
124 extern int check_refname_format(const char *ref, int flags);
125
126 extern const char *prettify_refname(const char *refname);
127 extern char *shorten_unambiguous_ref(const char *ref, int strict);
128
129 /** rename ref, return 0 on success **/
130 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
131
132 /** resolve ref in nested "gitlink" repository */
133 extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
134
135 /** lock a ref and then write its file */
136 enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
137 int 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
141 #endif /* REFS_H */