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