refs.h

   1 #ifndef REFS_H
   2 #define REFS_H
   3
   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;
  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  */
  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 *);
  26
  27 extern int peel_ref(const char *, unsigned char *);
  28
  29 /** Reads the refs file specified into sha1 **/
  30 extern int get_ref_sha1(const char *ref, unsigned char *sha1);
  31
  32 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
  33 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
  34
  35 /** Locks any ref (for 'HEAD' type refs). */
  36 #define REF_NODEREF     0x01
  37 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
  38
  39 /** Release any lock taken but not written. **/
  40 extern void unlock_ref(struct ref_lock *lock);
  41
  42 /** Writes sha1 into the ref specified by the lock. **/
  43 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
  44
  45 /** Reads log for the value of ref during at_time. **/
  46 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);
  47
  48 /* iterate over reflog entries */
  49 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
  50 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
  51
  52 /*
  53  * Calls the specified function for each reflog file until it returns nonzero,
  54  * and returns the value
  55  */
  56 extern int for_each_reflog(each_ref_fn, void *);
  57
  58 /** Returns 0 if target has the right format for a ref. **/
  59 extern int check_ref_format(const char *target);
  60
  61 /** rename ref, return 0 on success **/
  62 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
  63
  64 /** resolve ref in nested "gitlink" repository */
  65 extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
  66
  67 /** lock a ref and then write its file */
  68 enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
  69 int update_ref(const char *action, const char *refname,
  70                 const unsigned char *sha1, const unsigned char *oldval,
  71                 int flags, enum action_on_err onerr);
  72
  73 #endif /* REFS_H */