🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v1.7.0.3 / . / refs.h
blob: f7648b9bd3b719936024678246d0603028e72aa7 [file] [log] [blame]
Daniel Barkalow95fc7512005-06-06 20:31:29[diff] [blame]1#ifndef REFS_H
2#define REFS_H
3
Shawn Pearce4bd18c42006-05-17 09:55:02[diff] [blame]4struct ref_lock {
Linus Torvalds434cd0c2006-09-14 17:14:47[diff] [blame]5 char *ref_name;
Nicolas Pitre16557072007-01-26 22:26:06[diff] [blame]6 char *orig_ref_name;
Junio C Hamanoc33d5172006-06-06 20:54:14[diff] [blame]7 struct lock_file *lk;
Shawn Pearce4bd18c42006-05-17 09:55:02[diff] [blame]8 unsigned char old_sha1[20];
9 int lock_fd;
Shawn Pearce732232a2006-05-19 07:29:05[diff] [blame]10 int force_write;
Shawn Pearce4bd18c42006-05-17 09:55:02[diff] [blame]11};
12
Junio C Hamanof4204ab2006-11-22 07:36:35[diff] [blame]13#define REF_ISSYMREF 01
14#define REF_ISPACKED 02
15
Linus Torvalds8a65ff72005-07-03 03:23:36[diff] [blame]16/*
17 * Calls the specified function for each ref file until it returns nonzero,
18 * and returns the value
19 */
Junio C Hamano8da19772006-09-21 05:02:01[diff] [blame]20typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
Junio C Hamanocb5d7092006-09-21 04:47:42[diff] [blame]21extern int head_ref(each_ref_fn, void *);
22extern int for_each_ref(each_ref_fn, void *);
Christian Couder2a8177b2009-03-30 03:07:15[diff] [blame]23extern int for_each_ref_in(const char *, each_ref_fn, void *);
Junio C Hamanocb5d7092006-09-21 04:47:42[diff] [blame]24extern int for_each_tag_ref(each_ref_fn, void *);
25extern int for_each_branch_ref(each_ref_fn, void *);
26extern int for_each_remote_ref(each_ref_fn, void *);
Christian Couder29268702009-01-23 09:06:38[diff] [blame]27extern int for_each_replace_ref(each_ref_fn, void *);
Ilari Liusvaarad08bae72010-01-20 09:48:25[diff] [blame]28extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
Ilari Liusvaarab09fe972010-01-20 09:48:26[diff] [blame]29extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
Linus Torvalds8a65ff72005-07-03 03:23:36[diff] [blame]30
Junio C Hamanof8948e22009-02-09 07:27:10[diff] [blame]31/* can be used to learn about broken ref and symref */
32extern int for_each_rawref(each_ref_fn, void *);
33
Jay Soffian3cf61342009-11-10 05:03:32[diff] [blame]34extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
Junio C Hamanof8948e22009-02-09 07:27:10[diff] [blame]35
Daniel Barkalowe142a3c2008-04-27 17:39:24[diff] [blame]36/*
37 * Extra refs will be listed by for_each_ref() before any actual refs
38 * for the duration of this process or until clear_extra_refs() is
39 * called. Only extra refs added before for_each_ref() is called will
40 * be listed on a given call of for_each_ref().
41 */
42extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
43extern void clear_extra_refs(void);
44
Junio C Hamanocf0adba2006-11-19 21:22:44[diff] [blame]45extern int peel_ref(const char *, unsigned char *);
46
Shawn Pearce4bd18c42006-05-17 09:55:02[diff] [blame]47/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
Junio C Hamano4431fcc2006-09-27 08:09:18[diff] [blame]48extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
Daniel Barkalow95fc7512005-06-06 20:31:29[diff] [blame]49
Shawn Pearce4bd18c42006-05-17 09:55:02[diff] [blame]50/** Locks any ref (for 'HEAD' type refs). */
Sven Verdoolaege68db31c2007-05-09 10:33:20[diff] [blame]51#define REF_NODEREF 0x01
52extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
Daniel Barkalow95fc7512005-06-06 20:31:29[diff] [blame]53
Brandon Casey435fc852008-02-22 18:57:30[diff] [blame]54/** Close the file descriptor owned by a lock and return the status */
55extern int close_ref(struct ref_lock *lock);
56
57/** Close and commit the ref locked by the lock */
58extern int commit_ref(struct ref_lock *lock);
59
Shawn Pearce4bd18c42006-05-17 09:55:02[diff] [blame]60/** Release any lock taken but not written. **/
Junio C Hamanoe5f38ec2006-06-06 21:04:17[diff] [blame]61extern void unlock_ref(struct ref_lock *lock);
Shawn Pearce4bd18c42006-05-17 09:55:02[diff] [blame]62
63/** Writes sha1 into the ref specified by the lock. **/
64extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
Daniel Barkalow95fc7512005-06-06 20:31:29[diff] [blame]65
Shawn Pearced556fae2006-05-17 09:56:09[diff] [blame]66/** Reads log for the value of ref during at_time. **/
Junio C Hamano16d7cc92007-01-19 09:19:05[diff] [blame]67extern 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);
Shawn Pearced556fae2006-05-17 09:56:09[diff] [blame]68
Junio C Hamano2ff81662006-12-18 09:18:16[diff] [blame]69/* iterate over reflog entries */
Johannes Schindelin883d60f2007-01-08 00:59:54[diff] [blame]70typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
71int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
Junio C Hamano101d15e2009-01-20 06:18:29[diff] [blame]72int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data);
Junio C Hamano2ff81662006-12-18 09:18:16[diff] [blame]73
Nicolas Pitreeb8381c2007-02-03 18:25:43[diff] [blame]74/*
75 * Calls the specified function for each reflog file until it returns nonzero,
76 * and returns the value
77 */
78extern int for_each_reflog(each_ref_fn, void *);
79
Junio C Hamano5f7b2022008-01-02 06:33:20[diff] [blame]80#define CHECK_REF_FORMAT_OK 0
81#define CHECK_REF_FORMAT_ERROR (-1)
82#define CHECK_REF_FORMAT_ONELEVEL (-2)
83#define CHECK_REF_FORMAT_WILDCARD (-3)
Daniel Barkalow95fc7512005-06-06 20:31:29[diff] [blame]84extern int check_ref_format(const char *target);
85
Felipe Contreras4577e482009-05-13 21:22:04[diff] [blame]86extern const char *prettify_refname(const char *refname);
Bert Wesarg6e7b3302009-04-13 10:25:46[diff] [blame]87extern char *shorten_unambiguous_ref(const char *ref, int strict);
Daniel Barkalowa9c37a72009-03-09 01:06:05[diff] [blame]88
Lars Hjemlic976d412006-11-28 14:47:40[diff] [blame]89/** rename ref, return 0 on success **/
Lars Hjemli678d0f42006-11-30 02:16:56[diff] [blame]90extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
Lars Hjemlic976d412006-11-28 14:47:40[diff] [blame]91
Linus Torvalds0ebde322007-04-10 04:14:26[diff] [blame]92/** resolve ref in nested "gitlink" repository */
93extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
94
Carlos Rica3d9f0372007-09-05 01:38:24[diff] [blame]95/** lock a ref and then write its file */
96enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
97int update_ref(const char *action, const char *refname,
98 const unsigned char *sha1, const unsigned char *oldval,
99 int flags, enum action_on_err onerr);
100
Daniel Barkalow95fc7512005-06-06 20:31:29[diff] [blame]101#endif /* REFS_H */