Andrew's git / gitweb.git / refs.h
?
refs.hon commit Merge branch 'mb/relnotes-2.1' (764c739)
   1#ifndef REFS_H
   2#define REFS_H
   3
   4struct 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
  13struct ref_transaction;
  14
  15/*
  16 * Bit values set in the flags argument passed to each_ref_fn():
  17 */
  18
  19/* Reference is a symbolic reference. */
  20#define REF_ISSYMREF 0x01
  21
  22/* Reference is a packed reference. */
  23#define REF_ISPACKED 0x02
  24
  25/*
  26 * Reference cannot be resolved to an object name: dangling symbolic
  27 * reference (directly or indirectly), corrupt reference file, or
  28 * symbolic reference refers to ill-formatted reference name.
  29 */
  30#define REF_ISBROKEN 0x04
  31
  32/*
  33 * The signature for the callback function for the for_each_*()
  34 * functions below.  The memory pointed to by the refname and sha1
  35 * arguments is only guaranteed to be valid for the duration of a
  36 * single callback invocation.
  37 */
  38typedef int each_ref_fn(const char *refname,
  39                        const unsigned char *sha1, int flags, void *cb_data);
  40
  41/*
  42 * The following functions invoke the specified callback function for
  43 * each reference indicated.  If the function ever returns a nonzero
  44 * value, stop the iteration and return that value.  Please note that
  45 * it is not safe to modify references while an iteration is in
  46 * progress, unless the same callback function invocation that
  47 * modifies the reference also returns a nonzero value to immediately
  48 * stop the iteration.
  49 */
  50extern int head_ref(each_ref_fn, void *);
  51extern int for_each_ref(each_ref_fn, void *);
  52extern int for_each_ref_in(const char *, each_ref_fn, void *);
  53extern int for_each_tag_ref(each_ref_fn, void *);
  54extern int for_each_branch_ref(each_ref_fn, void *);
  55extern int for_each_remote_ref(each_ref_fn, void *);
  56extern int for_each_replace_ref(each_ref_fn, void *);
  57extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
  58extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
  59
  60extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  61extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  62extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
  63                each_ref_fn fn, void *cb_data);
  64extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  65extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  66extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  67
  68extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
  69extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
  70
  71static inline const char *has_glob_specials(const char *pattern)
  72{
  73        return strpbrk(pattern, "?*[");
  74}
  75
  76/* can be used to learn about broken ref and symref */
  77extern int for_each_rawref(each_ref_fn, void *);
  78
  79extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
  80extern void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list* refnames);
  81
  82/*
  83 * Lock the packed-refs file for writing.  Flags is passed to
  84 * hold_lock_file_for_update().  Return 0 on success.
  85 * Errno is set to something meaningful on error.
  86 */
  87extern int lock_packed_refs(int flags);
  88
  89/*
  90 * Add a reference to the in-memory packed reference cache.  This may
  91 * only be called while the packed-refs file is locked (see
  92 * lock_packed_refs()).  To actually write the packed-refs file, call
  93 * commit_packed_refs().
  94 */
  95extern void add_packed_ref(const char *refname, const unsigned char *sha1);
  96
  97/*
  98 * Write the current version of the packed refs cache from memory to
  99 * disk.  The packed-refs file must already be locked for writing (see
 100 * lock_packed_refs()).  Return zero on success.
 101 * Sets errno to something meaningful on error.
 102 */
 103extern int commit_packed_refs(void);
 104
 105/*
 106 * Rollback the lockfile for the packed-refs file, and discard the
 107 * in-memory packed reference cache.  (The packed-refs file will be
 108 * read anew if it is needed again after this function is called.)
 109 */
 110extern void rollback_packed_refs(void);
 111
 112/*
 113 * Flags for controlling behaviour of pack_refs()
 114 * PACK_REFS_PRUNE: Prune loose refs after packing
 115 * PACK_REFS_ALL:   Pack _all_ refs, not just tags and already packed refs
 116 */
 117#define PACK_REFS_PRUNE 0x0001
 118#define PACK_REFS_ALL   0x0002
 119
 120/*
 121 * Write a packed-refs file for the current repository.
 122 * flags: Combination of the above PACK_REFS_* flags.
 123 */
 124int pack_refs(unsigned int flags);
 125
 126extern int repack_without_refs(const char **refnames, int n,
 127                               struct strbuf *err);
 128
 129extern int ref_exists(const char *);
 130
 131extern int is_branch(const char *refname);
 132
 133/*
 134 * If refname is a non-symbolic reference that refers to a tag object,
 135 * and the tag can be (recursively) dereferenced to a non-tag object,
 136 * store the SHA1 of the referred-to object to sha1 and return 0.  If
 137 * any of these conditions are not met, return a non-zero value.
 138 * Symbolic references are considered unpeelable, even if they
 139 * ultimately resolve to a peelable tag.
 140 */
 141extern int peel_ref(const char *refname, unsigned char *sha1);
 142
 143/*
 144 * Locks a "refs/" ref returning the lock on success and NULL on failure.
 145 * On failure errno is set to something meaningful.
 146 */
 147extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
 148
 149/** Locks any ref (for 'HEAD' type refs). */
 150#define REF_NODEREF     0x01
 151/* errno is set to something meaningful on failure */
 152extern struct ref_lock *lock_any_ref_for_update(const char *refname,
 153                                                const unsigned char *old_sha1,
 154                                                int flags, int *type_p);
 155
 156/** Close the file descriptor owned by a lock and return the status */
 157extern int close_ref(struct ref_lock *lock);
 158
 159/** Close and commit the ref locked by the lock */
 160extern int commit_ref(struct ref_lock *lock);
 161
 162/** Release any lock taken but not written. **/
 163extern void unlock_ref(struct ref_lock *lock);
 164
 165/** Writes sha1 into the ref specified by the lock. **/
 166extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
 167
 168/*
 169 * Setup reflog before using. Set errno to something meaningful on failure.
 170 */
 171int log_ref_setup(const char *refname, char *logfile, int bufsize);
 172
 173/** Reads log for the value of ref during at_time. **/
 174extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
 175                       unsigned char *sha1, char **msg,
 176                       unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
 177
 178/** Check if a particular reflog exists */
 179extern int reflog_exists(const char *refname);
 180
 181/** Delete a reflog */
 182extern int delete_reflog(const char *refname);
 183
 184/* iterate over reflog entries */
 185typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
 186int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
 187int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
 188
 189/*
 190 * Calls the specified function for each reflog file until it returns nonzero,
 191 * and returns the value
 192 */
 193extern int for_each_reflog(each_ref_fn, void *);
 194
 195#define REFNAME_ALLOW_ONELEVEL 1
 196#define REFNAME_REFSPEC_PATTERN 2
 197#define REFNAME_DOT_COMPONENT 4
 198
 199/*
 200 * Return 0 iff refname has the correct format for a refname according
 201 * to the rules described in Documentation/git-check-ref-format.txt.
 202 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
 203 * reference names.  If REFNAME_REFSPEC_PATTERN is set in flags, then
 204 * allow a "*" wildcard character in place of one of the name
 205 * components.  No leading or repeated slashes are accepted.  If
 206 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
 207 * components to start with "." (but not a whole component equal to
 208 * "." or "..").
 209 */
 210extern int check_refname_format(const char *refname, int flags);
 211
 212extern const char *prettify_refname(const char *refname);
 213extern char *shorten_unambiguous_ref(const char *refname, int strict);
 214
 215/** rename ref, return 0 on success **/
 216extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
 217
 218/**
 219 * Resolve refname in the nested "gitlink" repository that is located
 220 * at path.  If the resolution is successful, return 0 and set sha1 to
 221 * the name of the object; otherwise, return a non-zero value.
 222 */
 223extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
 224
 225enum action_on_err {
 226        UPDATE_REFS_MSG_ON_ERR,
 227        UPDATE_REFS_DIE_ON_ERR,
 228        UPDATE_REFS_QUIET_ON_ERR
 229};
 230
 231/*
 232 * Begin a reference transaction.  The reference transaction must
 233 * be freed by calling ref_transaction_free().
 234 */
 235struct ref_transaction *ref_transaction_begin(void);
 236
 237/*
 238 * The following functions add a reference check or update to a
 239 * ref_transaction.  In all of them, refname is the name of the
 240 * reference to be affected.  The functions make internal copies of
 241 * refname, so the caller retains ownership of the parameter.  flags
 242 * can be REF_NODEREF; it is passed to update_ref_lock().
 243 */
 244
 245/*
 246 * Add a reference update to transaction.  new_sha1 is the value that
 247 * the reference should have after the update, or zeros if it should
 248 * be deleted.  If have_old is true, then old_sha1 holds the value
 249 * that the reference should have had before the update, or zeros if
 250 * it must not have existed beforehand.
 251 * Function returns 0 on success and non-zero on failure. A failure to update
 252 * means that the transaction as a whole has failed and will need to be
 253 * rolled back. On failure the err buffer will be updated.
 254 */
 255int ref_transaction_update(struct ref_transaction *transaction,
 256                           const char *refname,
 257                           const unsigned char *new_sha1,
 258                           const unsigned char *old_sha1,
 259                           int flags, int have_old,
 260                           struct strbuf *err);
 261
 262/*
 263 * Add a reference creation to transaction.  new_sha1 is the value
 264 * that the reference should have after the update; it must not be the
 265 * null SHA-1.  It is verified that the reference does not exist
 266 * already.
 267 */
 268void ref_transaction_create(struct ref_transaction *transaction,
 269                            const char *refname,
 270                            const unsigned char *new_sha1,
 271                            int flags);
 272
 273/*
 274 * Add a reference deletion to transaction.  If have_old is true, then
 275 * old_sha1 holds the value that the reference should have had before
 276 * the update (which must not be the null SHA-1).
 277 */
 278void ref_transaction_delete(struct ref_transaction *transaction,
 279                            const char *refname,
 280                            const unsigned char *old_sha1,
 281                            int flags, int have_old);
 282
 283/*
 284 * Commit all of the changes that have been queued in transaction, as
 285 * atomically as possible.  Return a nonzero value if there is a
 286 * problem.
 287 * If err is non-NULL we will add an error string to it to explain why
 288 * the transaction failed. The string does not end in newline.
 289 */
 290int ref_transaction_commit(struct ref_transaction *transaction,
 291                           const char *msg, struct strbuf *err);
 292
 293/*
 294 * Free an existing transaction and all associated data.
 295 */
 296void ref_transaction_free(struct ref_transaction *transaction);
 297
 298/** Lock a ref and then write its file */
 299int update_ref(const char *action, const char *refname,
 300                const unsigned char *sha1, const unsigned char *oldval,
 301                int flags, enum action_on_err onerr);
 302
 303extern int parse_hide_refs_config(const char *var, const char *value, const char *);
 304extern int ref_is_hidden(const char *);
 305
 306#endif /* REFS_H */