gitweb: use new Git::Repo API, and add optional caching
[git/gitweb-caching.git] / refs.h
blob06ad26055661a9b9e475d0f8a7bd6d1cfb42e792
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;
13 #define REF_ISSYMREF 01
14 #define REF_ISPACKED 02
17 * Calls the specified function for each ref file until it returns nonzero,
18 * and returns the value
20 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
21 extern int head_ref(each_ref_fn, void *);
22 extern int for_each_ref(each_ref_fn, void *);
23 extern int for_each_tag_ref(each_ref_fn, void *);
24 extern int for_each_branch_ref(each_ref_fn, void *);
25 extern int for_each_remote_ref(each_ref_fn, void *);
28 * Extra refs will be listed by for_each_ref() before any actual refs
29 * for the duration of this process or until clear_extra_refs() is
30 * called. Only extra refs added before for_each_ref() is called will
31 * be listed on a given call of for_each_ref().
33 extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
34 extern void clear_extra_refs(void);
36 extern int peel_ref(const char *, unsigned char *);
38 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
39 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
41 /** Locks any ref (for 'HEAD' type refs). */
42 #define REF_NODEREF 0x01
43 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
45 /** Close the file descriptor owned by a lock and return the status */
46 extern int close_ref(struct ref_lock *lock);
48 /** Close and commit the ref locked by the lock */
49 extern int commit_ref(struct ref_lock *lock);
51 /** Release any lock taken but not written. **/
52 extern void unlock_ref(struct ref_lock *lock);
54 /** Writes sha1 into the ref specified by the lock. **/
55 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
57 /** Reads log for the value of ref during at_time. **/
58 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);
60 /* iterate over reflog entries */
61 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
62 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
65 * Calls the specified function for each reflog file until it returns nonzero,
66 * and returns the value
68 extern int for_each_reflog(each_ref_fn, void *);
70 #define CHECK_REF_FORMAT_OK 0
71 #define CHECK_REF_FORMAT_ERROR (-1)
72 #define CHECK_REF_FORMAT_ONELEVEL (-2)
73 #define CHECK_REF_FORMAT_WILDCARD (-3)
74 extern int check_ref_format(const char *target);
76 /** rename ref, return 0 on success **/
77 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
79 /** resolve ref in nested "gitlink" repository */
80 extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
82 /** lock a ref and then write its file */
83 enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
84 int update_ref(const char *action, const char *refname,
85 const unsigned char *sha1, const unsigned char *oldval,
86 int flags, enum action_on_err onerr);
88 #endif /* REFS_H */