refs.h

   1 #ifndef REFS_H
   2 #define REFS_H
   3
   4 struct ref_lock {
   5         char *ref_file;
   6         char *lock_file;
   7         char *log_file;
   8         unsigned char old_sha1[20];
   9         int lock_fd;
  10         int force_write;
  11 };
  12
  13 /*
  14  * Calls the specified function for each ref file until it returns nonzero,
  15  * and returns the value
  16  */
  17 extern int head_ref(int (*fn)(const char *path, const unsigned char *sha1));
  18 extern int for_each_ref(int (*fn)(const char *path, const unsigned char *sha1));
  19 extern int for_each_tag_ref(int (*fn)(const char *path, const unsigned char *sha1));
  20 extern int for_each_branch_ref(int (*fn)(const char *path, const unsigned char *sha1));
  21 extern int for_each_remote_ref(int (*fn)(const char *path, const unsigned char *sha1));
  22
  23 /** Reads the refs file specified into sha1 **/
  24 extern int get_ref_sha1(const char *ref, unsigned char *sha1);
  25
  26 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
  27 extern struct ref_lock* lock_ref_sha1(const char *ref, const unsigned char *old_sha1, int mustexist);
  28
  29 /** Locks any ref (for 'HEAD' type refs). */
  30 extern struct ref_lock* lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int mustexist);
  31
  32 /** Release any lock taken but not written. **/
  33 extern void unlock_ref (struct ref_lock *lock);
  34
  35 /** Writes sha1 into the ref specified by the lock. **/
  36 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
  37
  38 /** Reads log for the value of ref during at_time. **/
  39 extern int read_ref_at(const char *ref, unsigned long at_time, unsigned char *sha1);
  40
  41 /** Returns 0 if target has the right format for a ref. **/
  42 extern int check_ref_format(const char *target);
  43
  44 #endif /* REFS_H */