refs: document the fields of struct ref_value
[alt-git.git] / refs.h
blobf111024a18049c6bca36aa1e03f67a6d9475c42e
1 #ifndef REFS_H
2 #define REFS_H
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;
14 * Bit values set in the flags argument passed to each_ref_fn():
17 /* Reference is a symbolic reference. */
18 #define REF_ISSYMREF 0x01
20 /* Reference is a packed reference. */
21 #define REF_ISPACKED 0x02
24 * Reference cannot be resolved to an object name: dangling symbolic
25 * reference (directly or indirectly), corrupt reference file, or
26 * symbolic reference refers to ill-formatted reference name.
28 #define REF_ISBROKEN 0x04
31 * Calls the specified function for each ref file until it returns
32 * nonzero, and returns the value. Please note that it is not safe to
33 * modify references while an iteration is in progress, unless the
34 * same callback function invocation that modifies the reference also
35 * returns a nonzero value to immediately stop the iteration.
37 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
38 extern int head_ref(each_ref_fn, void *);
39 extern int for_each_ref(each_ref_fn, void *);
40 extern int for_each_ref_in(const char *, each_ref_fn, void *);
41 extern int for_each_tag_ref(each_ref_fn, void *);
42 extern int for_each_branch_ref(each_ref_fn, void *);
43 extern int for_each_remote_ref(each_ref_fn, void *);
44 extern int for_each_replace_ref(each_ref_fn, void *);
45 extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
46 extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
48 extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
49 extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
50 extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
51 each_ref_fn fn, void *cb_data);
52 extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
53 extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
54 extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
56 extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
57 extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
59 static inline const char *has_glob_specials(const char *pattern)
61 return strpbrk(pattern, "?*[");
64 /* can be used to learn about broken ref and symref */
65 extern int for_each_rawref(each_ref_fn, void *);
67 extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
70 * Add a reference to the in-memory packed reference cache. To actually
71 * write the reference to the packed-refs file, call pack_refs().
73 extern void add_packed_ref(const char *refname, const unsigned char *sha1);
75 extern int ref_exists(const char *);
77 extern int peel_ref(const char *refname, unsigned char *sha1);
79 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
80 extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
82 /** Locks any ref (for 'HEAD' type refs). */
83 #define REF_NODEREF 0x01
84 extern struct ref_lock *lock_any_ref_for_update(const char *refname,
85 const unsigned char *old_sha1,
86 int flags);
88 /** Close the file descriptor owned by a lock and return the status */
89 extern int close_ref(struct ref_lock *lock);
91 /** Close and commit the ref locked by the lock */
92 extern int commit_ref(struct ref_lock *lock);
94 /** Release any lock taken but not written. **/
95 extern void unlock_ref(struct ref_lock *lock);
97 /** Writes sha1 into the ref specified by the lock. **/
98 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
101 * Invalidate the reference cache for the specified submodule. Use
102 * submodule=NULL to invalidate the cache for the main module. This
103 * function must be called if references are changed via a mechanism
104 * other than the refs API.
106 extern void invalidate_ref_cache(const char *submodule);
108 /** Setup reflog before using. **/
109 int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
111 /** Reads log for the value of ref during at_time. **/
112 extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
113 unsigned char *sha1, char **msg,
114 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
116 /* iterate over reflog entries */
117 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
118 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
119 int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long, void *cb_data);
122 * Calls the specified function for each reflog file until it returns nonzero,
123 * and returns the value
125 extern int for_each_reflog(each_ref_fn, void *);
127 #define REFNAME_ALLOW_ONELEVEL 1
128 #define REFNAME_REFSPEC_PATTERN 2
129 #define REFNAME_DOT_COMPONENT 4
132 * Return 0 iff refname has the correct format for a refname according
133 * to the rules described in Documentation/git-check-ref-format.txt.
134 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
135 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
136 * allow a "*" wildcard character in place of one of the name
137 * components. No leading or repeated slashes are accepted. If
138 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
139 * components to start with "." (but not a whole component equal to
140 * "." or "..").
142 extern int check_refname_format(const char *refname, int flags);
144 extern const char *prettify_refname(const char *refname);
145 extern char *shorten_unambiguous_ref(const char *refname, int strict);
147 /** rename ref, return 0 on success **/
148 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
151 * Resolve refname in the nested "gitlink" repository that is located
152 * at path. If the resolution is successful, return 0 and set sha1 to
153 * the name of the object; otherwise, return a non-zero value.
155 extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
157 /** lock a ref and then write its file */
158 enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
159 int update_ref(const char *action, const char *refname,
160 const unsigned char *sha1, const unsigned char *oldval,
161 int flags, enum action_on_err onerr);
163 #endif /* REFS_H */