]> git.ipfire.org Git - thirdparty/git.git/blame_incremental - refs.h
projects / thirdparty / git.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
grep: factor out create_grep_pat()
[thirdparty/git.git] / refs.h
... / ...
CommitLineData
1#ifndef REFS_H
2#define REFS_H
3
4struct 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 01
14#define REF_ISPACKED 02
15
16/*
17 * Calls the specified function for each ref file until it returns nonzero,
18 * and returns the value
19 */
20typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
21extern int head_ref(each_ref_fn, void *);
22extern int for_each_ref(each_ref_fn, void *);
23extern int for_each_ref_in(const char *, each_ref_fn, void *);
24extern int for_each_tag_ref(each_ref_fn, void *);
25extern int for_each_branch_ref(each_ref_fn, void *);
26extern int for_each_remote_ref(each_ref_fn, void *);
27extern int for_each_replace_ref(each_ref_fn, void *);
28extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
29extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
30
31extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
32extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
33extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
34 each_ref_fn fn, void *cb_data);
35extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
36extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
37extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
38
39static inline const char *has_glob_specials(const char *pattern)
40{
41 return strpbrk(pattern, "?*[");
42}
43
44/* can be used to learn about broken ref and symref */
45extern int for_each_rawref(each_ref_fn, void *);
46
47extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
48
49/*
50 * Extra refs will be listed by for_each_ref() before any actual refs
51 * for the duration of this process or until clear_extra_refs() is
52 * called. Only extra refs added before for_each_ref() is called will
53 * be listed on a given call of for_each_ref().
54 */
55extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
56extern void clear_extra_refs(void);
57extern int ref_exists(char *);
58
59extern int peel_ref(const char *, unsigned char *);
60
61/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
62extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
63
64/** Locks any ref (for 'HEAD' type refs). */
65#define REF_NODEREF 0x01
66extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
67
68/** Close the file descriptor owned by a lock and return the status */
69extern int close_ref(struct ref_lock *lock);
70
71/** Close and commit the ref locked by the lock */
72extern int commit_ref(struct ref_lock *lock);
73
74/** Release any lock taken but not written. **/
75extern void unlock_ref(struct ref_lock *lock);
76
77/** Writes sha1 into the ref specified by the lock. **/
78extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
79
80/** Setup reflog before using. **/
81int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
82
83/** Reads log for the value of ref during at_time. **/
84extern 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);
85
86/* iterate over reflog entries */
87typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
88int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
89int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data);
90
91/*
92 * Calls the specified function for each reflog file until it returns nonzero,
93 * and returns the value
94 */
95extern int for_each_reflog(each_ref_fn, void *);
96
97#define CHECK_REF_FORMAT_OK 0
98#define CHECK_REF_FORMAT_ERROR (-1)
99#define CHECK_REF_FORMAT_ONELEVEL (-2)
100#define CHECK_REF_FORMAT_WILDCARD (-3)
101extern int check_ref_format(const char *target);
102
103extern const char *prettify_refname(const char *refname);
104extern char *shorten_unambiguous_ref(const char *ref, int strict);
105
106/** rename ref, return 0 on success **/
107extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
108
109/** resolve ref in nested "gitlink" repository */
110extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
111
112/** lock a ref and then write its file */
113enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
114int update_ref(const char *action, const char *refname,
115 const unsigned char *sha1, const unsigned char *oldval,
116 int flags, enum action_on_err onerr);
117
118#endif /* REFS_H */
Unnamed repository; edit this file 'description' to name the repository.