[thirdparty/git.git] / refs.h

#ifndef REFS_H
#define REFS_H

struct ref_lock {
	char *ref_name;
	char *orig_ref_name;
	struct lock_file *lk;
	unsigned char old_sha1[20];
	int lock_fd;
	int force_write;
};

#define REF_ISSYMREF 01
#define REF_ISPACKED 02

/*
 * Calls the specified function for each ref file until it returns nonzero,
 * and returns the value
 */
typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
extern int head_ref(each_ref_fn, void *);
extern int for_each_ref(each_ref_fn, void *);
extern int for_each_ref_in(const char *, each_ref_fn, void *);
extern int for_each_tag_ref(each_ref_fn, void *);
extern int for_each_branch_ref(each_ref_fn, void *);
extern int for_each_remote_ref(each_ref_fn, void *);
extern int for_each_replace_ref(each_ref_fn, void *);
extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);

static inline const char *has_glob_specials(const char *pattern)
{
	return strpbrk(pattern, "?*[");
}

/* can be used to learn about broken ref and symref */
extern int for_each_rawref(each_ref_fn, void *);

extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);

/*
 * Extra refs will be listed by for_each_ref() before any actual refs
 * for the duration of this process or until clear_extra_refs() is
 * called. Only extra refs added before for_each_ref() is called will
 * be listed on a given call of for_each_ref().
 */
extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
extern void clear_extra_refs(void);

extern int peel_ref(const char *, unsigned char *);

/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);

/** Locks any ref (for 'HEAD' type refs). */
#define REF_NODEREF	0x01
extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);

/** Close the file descriptor owned by a lock and return the status */
extern int close_ref(struct ref_lock *lock);

/** Close and commit the ref locked by the lock */
extern int commit_ref(struct ref_lock *lock);

/** Release any lock taken but not written. **/
extern void unlock_ref(struct ref_lock *lock);

/** Writes sha1 into the ref specified by the lock. **/
extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);

/** Setup reflog before using. **/
int log_ref_setup(const char *ref_name, char *logfile, int bufsize);

/** Reads log for the value of ref during at_time. **/
extern 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);

/* iterate over reflog entries */
typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data);

/*
 * Calls the specified function for each reflog file until it returns nonzero,
 * and returns the value
 */
extern int for_each_reflog(each_ref_fn, void *);

#define CHECK_REF_FORMAT_OK 0
#define CHECK_REF_FORMAT_ERROR (-1)
#define CHECK_REF_FORMAT_ONELEVEL (-2)
#define CHECK_REF_FORMAT_WILDCARD (-3)
extern int check_ref_format(const char *target);

extern const char *prettify_refname(const char *refname);
extern char *shorten_unambiguous_ref(const char *ref, int strict);

/** rename ref, return 0 on success **/
extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);

/** resolve ref in nested "gitlink" repository */
extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);

/** lock a ref and then write its file */
enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
int update_ref(const char *action, const char *refname,
		const unsigned char *sha1, const unsigned char *oldval,
		int flags, enum action_on_err onerr);

#endif /* REFS_H */
Commit	Line	Data
	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 01
	14	#define REF_ISPACKED 02
	15
	16	/*
	17	* Calls the specified function for each ref file until it returns nonzero,
	18	* and returns the value
	19	*/
	20	typedef int each_ref_fn(const char refname, const unsigned char sha1, int flags, void *cb_data);
	21	extern int head_ref(each_ref_fn, void *);
	22	extern int for_each_ref(each_ref_fn, void *);
	23	extern int for_each_ref_in(const char , each_ref_fn, void );
	24	extern int for_each_tag_ref(each_ref_fn, void *);
	25	extern int for_each_branch_ref(each_ref_fn, void *);
	26	extern int for_each_remote_ref(each_ref_fn, void *);
	27	extern int for_each_replace_ref(each_ref_fn, void *);
	28	extern int for_each_glob_ref(each_ref_fn, const char pattern, void );
	29	extern int for_each_glob_ref_in(each_ref_fn, const char pattern, const char prefix, void *);
	30
	31	static inline const char has_glob_specials(const char pattern)
	32	{
	33	return strpbrk(pattern, "?*[");
	34	}
	35
	36	/* can be used to learn about broken ref and symref */
	37	extern int for_each_rawref(each_ref_fn, void *);
	38
	39	extern void warn_dangling_symref(FILE fp, const char msg_fmt, const char *refname);
	40
	41	/*
	42	* Extra refs will be listed by for_each_ref() before any actual refs
	43	* for the duration of this process or until clear_extra_refs() is
	44	* called. Only extra refs added before for_each_ref() is called will
	45	* be listed on a given call of for_each_ref().
	46	*/
	47	extern void add_extra_ref(const char refname, const unsigned char sha1, int flags);
	48	extern void clear_extra_refs(void);
	49
	50	extern int peel_ref(const char , unsigned char );
	51
	52	/ Locks a "refs/" ref returning the lock on success and NULL on failure. /
	53	extern struct ref_lock lock_ref_sha1(const char ref, const unsigned char *old_sha1);
	54
	55	/** Locks any ref (for 'HEAD' type refs). */
	56	#define REF_NODEREF 0x01
	57	extern struct ref_lock lock_any_ref_for_update(const char ref, const unsigned char *old_sha1, int flags);
	58
	59	/** Close the file descriptor owned by a lock and return the status */
	60	extern int close_ref(struct ref_lock *lock);
	61
	62	/** Close and commit the ref locked by the lock */
	63	extern int commit_ref(struct ref_lock *lock);
	64
	65	/ Release any lock taken but not written. /
	66	extern void unlock_ref(struct ref_lock *lock);
	67
	68	/ Writes sha1 into the ref specified by the lock. /
	69	extern int write_ref_sha1(struct ref_lock lock, const unsigned char sha1, const char *msg);
	70
	71	/ Setup reflog before using. /
	72	int log_ref_setup(const char ref_name, char logfile, int bufsize);
	73
	74	/ Reads log for the value of ref during at_time. /
	75	extern 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);
	76
	77	/* iterate over reflog entries */
	78	typedef int each_reflog_ent_fn(unsigned char osha1, unsigned char nsha1, const char , unsigned long, int, const char , void *);
	79	int for_each_reflog_ent(const char ref, each_reflog_ent_fn fn, void cb_data);
	80	int for_each_recent_reflog_ent(const char ref, each_reflog_ent_fn fn, long, void cb_data);
	81
	82	/*
	83	* Calls the specified function for each reflog file until it returns nonzero,
	84	* and returns the value
	85	*/
	86	extern int for_each_reflog(each_ref_fn, void *);
	87
	88	#define CHECK_REF_FORMAT_OK 0
	89	#define CHECK_REF_FORMAT_ERROR (-1)
	90	#define CHECK_REF_FORMAT_ONELEVEL (-2)
	91	#define CHECK_REF_FORMAT_WILDCARD (-3)
	92	extern int check_ref_format(const char *target);
	93
	94	extern const char prettify_refname(const char refname);
	95	extern char shorten_unambiguous_ref(const char ref, int strict);
	96
	97	/ rename ref, return 0 on success /
	98	extern int rename_ref(const char oldref, const char newref, const char *logmsg);
	99
	100	/** resolve ref in nested "gitlink" repository */
	101	extern int resolve_gitlink_ref(const char name, const char refname, unsigned char *result);
	102
	103	/** lock a ref and then write its file */
	104	enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
	105	int update_ref(const char action, const char refname,
	106	const unsigned char sha1, const unsigned char oldval,
	107	int flags, enum action_on_err onerr);
	108
	109	#endif /* REFS_H */