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 0x01
  14 #define REF_ISPACKED 0x02
  15 #define REF_ISBROKEN 0x04
  16
  17 /*
  18  * Calls the specified function for each ref file until it returns
  19  * nonzero, and returns the value.  Please note that it is not safe to
  20  * modify references while an iteration is in progress, unless the
  21  * same callback function invocation that modifies the reference also
  22  * returns a nonzero value to immediately stop the iteration.
  23  */
  24 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
  25 extern int head_ref(each_ref_fn, void *);
  26 extern int for_each_ref(each_ref_fn, void *);
  27 extern int for_each_ref_in(const char *, each_ref_fn, void *);
  28 extern int for_each_tag_ref(each_ref_fn, void *);
  29 extern int for_each_branch_ref(each_ref_fn, void *);
  30 extern int for_each_remote_ref(each_ref_fn, void *);
  31 extern int for_each_replace_ref(each_ref_fn, void *);
  32 extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
  33 extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
  34
  35 extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  36 extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  37 extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
  38                 each_ref_fn fn, void *cb_data);
  39 extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  40 extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  41 extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  42
  43 extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
  44 extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
  45
  46 static inline const char *has_glob_specials(const char *pattern)
  47 {
  48         return strpbrk(pattern, "?*[");
  49 }
  50
  51 /* can be used to learn about broken ref and symref */
  52 extern int for_each_rawref(each_ref_fn, void *);
  53
  54 extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
  55
  56 /*
  57  * Add a reference to the in-memory packed reference cache.  To actually
  58  * write the reference to the packed-refs file, call pack_refs().
  59  */
  60 extern void add_packed_ref(const char *refname, const unsigned char *sha1);
  61
  62 extern int ref_exists(const char *);
  63
  64 extern int peel_ref(const char *refname, unsigned char *sha1);
  65
  66 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
  67 extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
  68
  69 /** Locks any ref (for 'HEAD' type refs). */
  70 #define REF_NODEREF     0x01
  71 extern struct ref_lock *lock_any_ref_for_update(const char *refname,
  72                                                 const unsigned char *old_sha1,
  73                                                 int flags);
  74
  75 /** Close the file descriptor owned by a lock and return the status */
  76 extern int close_ref(struct ref_lock *lock);
  77
  78 /** Close and commit the ref locked by the lock */
  79 extern int commit_ref(struct ref_lock *lock);
  80
  81 /** Release any lock taken but not written. **/
  82 extern void unlock_ref(struct ref_lock *lock);
  83
  84 /** Writes sha1 into the ref specified by the lock. **/
  85 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
  86
  87 /*
  88  * Invalidate the reference cache for the specified submodule.  Use
  89  * submodule=NULL to invalidate the cache for the main module.  This
  90  * function must be called if references are changed via a mechanism
  91  * other than the refs API.
  92  */
  93 extern void invalidate_ref_cache(const char *submodule);
  94
  95 /** Setup reflog before using. **/
  96 int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
  97
  98 /** Reads log for the value of ref during at_time. **/
  99 extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
 100                        unsigned char *sha1, char **msg,
 101                        unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
 102
 103 /* iterate over reflog entries */
 104 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
 105 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
 106 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
 107
 108 /*
 109  * Calls the specified function for each reflog file until it returns nonzero,
 110  * and returns the value
 111  */
 112 extern int for_each_reflog(each_ref_fn, void *);
 113
 114 #define REFNAME_ALLOW_ONELEVEL 1
 115 #define REFNAME_REFSPEC_PATTERN 2
 116 #define REFNAME_DOT_COMPONENT 4
 117
 118 /*
 119  * Return 0 iff refname has the correct format for a refname according
 120  * to the rules described in Documentation/git-check-ref-format.txt.
 121  * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
 122  * reference names.  If REFNAME_REFSPEC_PATTERN is set in flags, then
 123  * allow a "*" wildcard character in place of one of the name
 124  * components.  No leading or repeated slashes are accepted.  If
 125  * REFNAME_DOT_COMPONENT is set in flags, then allow refname
 126  * components to start with "." (but not a whole component equal to
 127  * "." or "..").
 128  */
 129 extern int check_refname_format(const char *refname, int flags);
 130
 131 extern const char *prettify_refname(const char *refname);
 132 extern char *shorten_unambiguous_ref(const char *refname, int strict);
 133
 134 /** rename ref, return 0 on success **/
 135 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
 136
 137 /**
 138  * Resolve refname in the nested "gitlink" repository that is located
 139  * at path.  If the resolution is successful, return 0 and set sha1 to
 140  * the name of the object; otherwise, return a non-zero value.
 141  */
 142 extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
 143
 144 /** lock a ref and then write its file */
 145 enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
 146 int update_ref(const char *action, const char *refname,
 147                 const unsigned char *sha1, const unsigned char *oldval,
 148                 int flags, enum action_on_err onerr);
 149
 150 #endif /* REFS_H */