Make "index_name_exists()" return the cache_entry it found
[git/dscho.git] / refs.h
blob06abee15266cc3b234ec64cd27362c482874e54b
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 *);
27 extern int peel_ref(const char *, unsigned char *);
29 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
30 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
32 /** Locks any ref (for 'HEAD' type refs). */
33 #define REF_NODEREF 0x01
34 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
36 /** Close the file descriptor owned by a lock and return the status */
37 extern int close_ref(struct ref_lock *lock);
39 /** Close and commit the ref locked by the lock */
40 extern int commit_ref(struct ref_lock *lock);
42 /** Release any lock taken but not written. **/
43 extern void unlock_ref(struct ref_lock *lock);
45 /** Writes sha1 into the ref specified by the lock. **/
46 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
48 /** Reads log for the value of ref during at_time. **/
49 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);
51 /* iterate over reflog entries */
52 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
53 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
56 * Calls the specified function for each reflog file until it returns nonzero,
57 * and returns the value
59 extern int for_each_reflog(each_ref_fn, void *);
61 #define CHECK_REF_FORMAT_OK 0
62 #define CHECK_REF_FORMAT_ERROR (-1)
63 #define CHECK_REF_FORMAT_ONELEVEL (-2)
64 #define CHECK_REF_FORMAT_WILDCARD (-3)
65 extern int check_ref_format(const char *target);
67 /** rename ref, return 0 on success **/
68 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
70 /** resolve ref in nested "gitlink" repository */
71 extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
73 /** lock a ref and then write its file */
74 enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
75 int update_ref(const char *action, const char *refname,
76 const unsigned char *sha1, const unsigned char *oldval,
77 int flags, enum action_on_err onerr);
79 #endif /* REFS_H */