Andrew's git / gitweb.git / refs.h
?
refs.hon commit trace: move trace declarations from cache.h to new trace.h (5991a55)
   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 */
  86extern int lock_packed_refs(int flags);
  87
  88/*
  89 * Add a reference to the in-memory packed reference cache.  This may
  90 * only be called while the packed-refs file is locked (see
  91 * lock_packed_refs()).  To actually write the packed-refs file, call
  92 * commit_packed_refs().
  93 */
  94extern void add_packed_ref(const char *refname, const unsigned char *sha1);
  95
  96/*
  97 * Write the current version of the packed refs cache from memory to
  98 * disk.  The packed-refs file must already be locked for writing (see
  99 * lock_packed_refs()).  Return zero on success.
 100 */
 101extern int commit_packed_refs(void);
 102
 103/*
 104 * Rollback the lockfile for the packed-refs file, and discard the
 105 * in-memory packed reference cache.  (The packed-refs file will be
 106 * read anew if it is needed again after this function is called.)
 107 */
 108extern void rollback_packed_refs(void);
 109
 110/*
 111 * Flags for controlling behaviour of pack_refs()
 112 * PACK_REFS_PRUNE: Prune loose refs after packing
 113 * PACK_REFS_ALL:   Pack _all_ refs, not just tags and already packed refs
 114 */
 115#define PACK_REFS_PRUNE 0x0001
 116#define PACK_REFS_ALL   0x0002
 117
 118/*
 119 * Write a packed-refs file for the current repository.
 120 * flags: Combination of the above PACK_REFS_* flags.
 121 */
 122int pack_refs(unsigned int flags);
 123
 124extern int repack_without_refs(const char **refnames, int n);
 125
 126extern int ref_exists(const char *);
 127
 128/*
 129 * If refname is a non-symbolic reference that refers to a tag object,
 130 * and the tag can be (recursively) dereferenced to a non-tag object,
 131 * store the SHA1 of the referred-to object to sha1 and return 0.  If
 132 * any of these conditions are not met, return a non-zero value.
 133 * Symbolic references are considered unpeelable, even if they
 134 * ultimately resolve to a peelable tag.
 135 */
 136extern int peel_ref(const char *refname, unsigned char *sha1);
 137
 138/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
 139extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
 140
 141/** Locks any ref (for 'HEAD' type refs). */
 142#define REF_NODEREF     0x01
 143extern struct ref_lock *lock_any_ref_for_update(const char *refname,
 144                                                const unsigned char *old_sha1,
 145                                                int flags, int *type_p);
 146
 147/** Close the file descriptor owned by a lock and return the status */
 148extern int close_ref(struct ref_lock *lock);
 149
 150/** Close and commit the ref locked by the lock */
 151extern int commit_ref(struct ref_lock *lock);
 152
 153/** Release any lock taken but not written. **/
 154extern void unlock_ref(struct ref_lock *lock);
 155
 156/** Writes sha1 into the ref specified by the lock. **/
 157extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
 158
 159/** Setup reflog before using. **/
 160int log_ref_setup(const char *refname, char *logfile, int bufsize);
 161
 162/** Reads log for the value of ref during at_time. **/
 163extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
 164                       unsigned char *sha1, char **msg,
 165                       unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
 166
 167/** Check if a particular reflog exists */
 168extern int reflog_exists(const char *refname);
 169
 170/** Delete a reflog */
 171extern int delete_reflog(const char *refname);
 172
 173/* iterate over reflog entries */
 174typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
 175int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
 176int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
 177
 178/*
 179 * Calls the specified function for each reflog file until it returns nonzero,
 180 * and returns the value
 181 */
 182extern int for_each_reflog(each_ref_fn, void *);
 183
 184#define REFNAME_ALLOW_ONELEVEL 1
 185#define REFNAME_REFSPEC_PATTERN 2
 186#define REFNAME_DOT_COMPONENT 4
 187
 188/*
 189 * Return 0 iff refname has the correct format for a refname according
 190 * to the rules described in Documentation/git-check-ref-format.txt.
 191 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
 192 * reference names.  If REFNAME_REFSPEC_PATTERN is set in flags, then
 193 * allow a "*" wildcard character in place of one of the name
 194 * components.  No leading or repeated slashes are accepted.  If
 195 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
 196 * components to start with "." (but not a whole component equal to
 197 * "." or "..").
 198 */
 199extern int check_refname_format(const char *refname, int flags);
 200
 201extern const char *prettify_refname(const char *refname);
 202extern char *shorten_unambiguous_ref(const char *refname, int strict);
 203
 204/** rename ref, return 0 on success **/
 205extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
 206
 207/**
 208 * Resolve refname in the nested "gitlink" repository that is located
 209 * at path.  If the resolution is successful, return 0 and set sha1 to
 210 * the name of the object; otherwise, return a non-zero value.
 211 */
 212extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
 213
 214enum action_on_err {
 215        UPDATE_REFS_MSG_ON_ERR,
 216        UPDATE_REFS_DIE_ON_ERR,
 217        UPDATE_REFS_QUIET_ON_ERR
 218};
 219
 220/*
 221 * Begin a reference transaction.  The reference transaction must
 222 * eventually be commited using ref_transaction_commit() or rolled
 223 * back using ref_transaction_rollback().
 224 */
 225struct ref_transaction *ref_transaction_begin(void);
 226
 227/*
 228 * Roll back a ref_transaction and free all associated data.
 229 */
 230void ref_transaction_rollback(struct ref_transaction *transaction);
 231
 232
 233/*
 234 * The following functions add a reference check or update to a
 235 * ref_transaction.  In all of them, refname is the name of the
 236 * reference to be affected.  The functions make internal copies of
 237 * refname, so the caller retains ownership of the parameter.  flags
 238 * can be REF_NODEREF; it is passed to update_ref_lock().
 239 */
 240
 241
 242/*
 243 * Add a reference update to transaction.  new_sha1 is the value that
 244 * the reference should have after the update, or zeros if it should
 245 * be deleted.  If have_old is true, then old_sha1 holds the value
 246 * that the reference should have had before the update, or zeros if
 247 * it must not have existed beforehand.
 248 */
 249void ref_transaction_update(struct ref_transaction *transaction,
 250                            const char *refname,
 251                            unsigned char *new_sha1, unsigned char *old_sha1,
 252                            int flags, int have_old);
 253
 254/*
 255 * Add a reference creation to transaction.  new_sha1 is the value
 256 * that the reference should have after the update; it must not be the
 257 * null SHA-1.  It is verified that the reference does not exist
 258 * already.
 259 */
 260void ref_transaction_create(struct ref_transaction *transaction,
 261                            const char *refname,
 262                            unsigned char *new_sha1,
 263                            int flags);
 264
 265/*
 266 * Add a reference deletion to transaction.  If have_old is true, then
 267 * old_sha1 holds the value that the reference should have had before
 268 * the update (which must not be the null SHA-1).
 269 */
 270void ref_transaction_delete(struct ref_transaction *transaction,
 271                            const char *refname,
 272                            unsigned char *old_sha1,
 273                            int flags, int have_old);
 274
 275/*
 276 * Commit all of the changes that have been queued in transaction, as
 277 * atomically as possible.  Return a nonzero value if there is a
 278 * problem.  The ref_transaction is freed by this function.
 279 */
 280int ref_transaction_commit(struct ref_transaction *transaction,
 281                           const char *msg, enum action_on_err onerr);
 282
 283/** Lock a ref and then write its file */
 284int update_ref(const char *action, const char *refname,
 285                const unsigned char *sha1, const unsigned char *oldval,
 286                int flags, enum action_on_err onerr);
 287
 288extern int parse_hide_refs_config(const char *var, const char *value, const char *);
 289extern int ref_is_hidden(const char *);
 290
 291#endif /* REFS_H */