refs.h

   1 #ifndef REFS_H
   2 #define REFS_H
   3
   4 struct ref_lock {
   5         char *ref_name;
   6         struct lock_file *lk;
   7         unsigned char old_sha1[20];
   8         int lock_fd;
   9         int force_write;
  10 };
  11
  12 #define REF_ISSYMREF 01
  13 #define REF_ISPACKED 02
  14
  15 /*
  16  * Calls the specified function for each ref file until it returns nonzero,
  17  * and returns the value
  18  */
  19 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
  20 extern int head_ref(each_ref_fn, void *);
  21 extern int for_each_ref(each_ref_fn, void *);
  22 extern int for_each_tag_ref(each_ref_fn, void *);
  23 extern int for_each_branch_ref(each_ref_fn, void *);
  24 extern int for_each_remote_ref(each_ref_fn, void *);
  25
  26 extern int peel_ref(const char *, unsigned char *);
  27
  28 /** Reads the refs file specified into sha1 **/
  29 extern int get_ref_sha1(const char *ref, unsigned char *sha1);
  30
  31 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
  32 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
  33
  34 /** Locks any ref (for 'HEAD' type refs). */
  35 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1);
  36
  37 /** Release any lock taken but not written. **/
  38 extern void unlock_ref(struct ref_lock *lock);
  39
  40 /** Writes sha1 into the ref specified by the lock. **/
  41 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
  42
  43 /** Reads log for the value of ref during at_time. **/
  44 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);
  45
  46 /* iterate over reflog entries */
  47 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
  48 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
  49
  50 /** Returns 0 if target has the right format for a ref. **/
  51 extern int check_ref_format(const char *target);
  52
  53 /** rename ref, return 0 on success **/
  54 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
  55
  56 #endif /* REFS_H */