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_ref_in(const char *, each_ref_fn, void *);
  24 extern int for_each_tag_ref(each_ref_fn, void *);
  25 extern int for_each_branch_ref(each_ref_fn, void *);
  26 extern int for_each_remote_ref(each_ref_fn, void *);
  27 extern int for_each_replace_ref(each_ref_fn, void *);
  28 extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
  29 extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
  30
  31 extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  32 extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  33 extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
  34                 each_ref_fn fn, void *cb_data);
  35 extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  36 extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  37 extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  38
  39 extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
  40 extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
  41
  42 static inline const char *has_glob_specials(const char *pattern)
  43 {
  44         return strpbrk(pattern, "?*[");
  45 }
  46
  47 /* can be used to learn about broken ref and symref */
  48 extern int for_each_rawref(each_ref_fn, void *);
  49
  50 extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
  51
  52 /*
  53  * Extra refs will be listed by for_each_ref() before any actual refs
  54  * for the duration of this process or until clear_extra_refs() is
  55  * called. Only extra refs added before for_each_ref() is called will
  56  * be listed on a given call of for_each_ref().
  57  */
  58 extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
  59 extern void clear_extra_refs(void);
  60 extern int ref_exists(const char *);
  61
  62 extern int peel_ref(const char *, unsigned char *);
  63
  64 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
  65 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
  66
  67 /** Locks any ref (for 'HEAD' type refs). */
  68 #define REF_NODEREF     0x01
  69 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
  70
  71 /** Close the file descriptor owned by a lock and return the status */
  72 extern int close_ref(struct ref_lock *lock);
  73
  74 /** Close and commit the ref locked by the lock */
  75 extern int commit_ref(struct ref_lock *lock);
  76
  77 /** Release any lock taken but not written. **/
  78 extern void unlock_ref(struct ref_lock *lock);
  79
  80 /** Writes sha1 into the ref specified by the lock. **/
  81 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
  82
  83 /** Setup reflog before using. **/
  84 int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
  85
  86 /** Reads log for the value of ref during at_time. **/
  87 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);
  88
  89 /* iterate over reflog entries */
  90 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
  91 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
  92 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data);
  93
  94 /*
  95  * Calls the specified function for each reflog file until it returns nonzero,
  96  * and returns the value
  97  */
  98 extern int for_each_reflog(each_ref_fn, void *);
  99
 100 #define REFNAME_ALLOW_ONELEVEL 1
 101 #define REFNAME_REFSPEC_PATTERN 2
 102 #define REFNAME_DOT_COMPONENT 4
 103
 104 /*
 105  * Return 0 iff ref has the correct format for a refname according to
 106  * the rules described in Documentation/git-check-ref-format.txt.  If
 107  * REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
 108  * reference names.  If REFNAME_REFSPEC_PATTERN is set in flags, then
 109  * allow a "*" wildcard character in place of one of the name
 110  * components.  No leading or repeated slashes are accepted.  If
 111  * REFNAME_DOT_COMPONENT is set in flags, then allow refname
 112  * components to start with "." (but not a whole component equal to
 113  * "." or "..").
 114  */
 115 extern int check_refname_format(const char *ref, int flags);
 116
 117 extern const char *prettify_refname(const char *refname);
 118 extern char *shorten_unambiguous_ref(const char *ref, int strict);
 119
 120 /** rename ref, return 0 on success **/
 121 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
 122
 123 /** resolve ref in nested "gitlink" repository */
 124 extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
 125
 126 /** lock a ref and then write its file */
 127 enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
 128 int update_ref(const char *action, const char *refname,
 129                 const unsigned char *sha1, const unsigned char *oldval,
 130                 int flags, enum action_on_err onerr);
 131
 132 #endif /* REFS_H */