[thirdparty/git.git] / ref-filter.h

#ifndef REF_FILTER_H
#define REF_FILTER_H

#include "sha1-array.h"
#include "refs.h"
#include "commit.h"
#include "parse-options.h"

/* Quoting styles */
#define QUOTE_NONE 0
#define QUOTE_SHELL 1
#define QUOTE_PERL 2
#define QUOTE_PYTHON 4
#define QUOTE_TCL 8

#define FILTER_REFS_INCLUDE_BROKEN 0x0001
#define FILTER_REFS_TAGS           0x0002
#define FILTER_REFS_BRANCHES       0x0004
#define FILTER_REFS_REMOTES        0x0008
#define FILTER_REFS_OTHERS         0x0010
#define FILTER_REFS_ALL            (FILTER_REFS_TAGS | FILTER_REFS_BRANCHES | \
				    FILTER_REFS_REMOTES | FILTER_REFS_OTHERS)
#define FILTER_REFS_DETACHED_HEAD  0x0020
#define FILTER_REFS_KIND_MASK      (FILTER_REFS_ALL | FILTER_REFS_DETACHED_HEAD)

struct atom_value;

struct ref_sorting {
	struct ref_sorting *next;
	int atom; /* index into used_atom array (internal) */
	unsigned reverse : 1,
		ignore_case : 1,
		version : 1;
};

struct ref_array_item {
	struct object_id objectname;
	int flag;
	unsigned int kind;
	const char *symref;
	struct commit *commit;
	struct atom_value *value;
	char refname[FLEX_ARRAY];
};

struct ref_array {
	int nr, alloc;
	struct ref_array_item **items;
	struct rev_info *revs;
};

struct ref_filter {
	const char **name_patterns;
	struct oid_array points_at;
	struct commit_list *with_commit;
	struct commit_list *no_commit;

	enum {
		REF_FILTER_MERGED_NONE = 0,
		REF_FILTER_MERGED_INCLUDE,
		REF_FILTER_MERGED_OMIT
	} merge;
	struct commit *merge_commit;

	unsigned int with_commit_tag_algo : 1,
		match_as_path : 1,
		ignore_case : 1,
		detached : 1;
	unsigned int kind,
		lines;
	int abbrev,
		verbose;
};

struct ref_format {
	/*
	 * Set these to define the format; make sure you call
	 * verify_ref_format() afterwards to finalize.
	 */
	const char *format;
	int quote_style;
	int use_color;

	/* Internal state to ref-filter */
	int need_color_reset_at_eol;
};

#define REF_FORMAT_INIT { NULL, 0, -1 }

/*  Macros for checking --merged and --no-merged options */
#define _OPT_MERGED_NO_MERGED(option, filter, h) \
	{ OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
	  PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \
	  parse_opt_merge_filter, (intptr_t) "HEAD" \
	}
#define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
#define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)

#define OPT_REF_SORT(var) \
	OPT_CALLBACK_F(0, "sort", (var), \
		       N_("key"), N_("field name to sort on"), \
		       PARSE_OPT_NONEG, parse_opt_ref_sorting)

/*
 * API for filtering a set of refs. Based on the type of refs the user
 * has requested, we iterate through those refs and apply filters
 * as per the given ref_filter structure and finally store the
 * filtered refs in the ref_array structure.
 */
int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
/*  Clear all memory allocated to ref_array */
void ref_array_clear(struct ref_array *array);
/*  Used to verify if the given format is correct and to parse out the used atoms */
int verify_ref_format(struct ref_format *format);
/*  Sort the given ref_array as per the ref_sorting provided */
void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
/*  Based on the given format and quote_style, fill the strbuf */
int format_ref_array_item(struct ref_array_item *info,
			  const struct ref_format *format,
			  struct strbuf *final_buf,
			  struct strbuf *error_buf);
/*  Print the ref using the given format and quote_style */
void show_ref_array_item(struct ref_array_item *info, const struct ref_format *format);
/*  Parse a single sort specifier and add it to the list */
void parse_ref_sorting(struct ref_sorting **sorting_tail, const char *atom);
/*  Callback function for parsing the sort option */
int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset);
/*  Default sort option based on refname */
struct ref_sorting *ref_default_sorting(void);
/*  Function to parse --merged and --no-merged options */
int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
/*  Get the current HEAD's description */
char *get_head_description(void);
/*  Set up translated strings in the output. */
void setup_ref_filter_porcelain_msg(void);

/*
 * Print a single ref, outside of any ref-filter. Note that the
 * name must be a fully qualified refname.
 */
void pretty_print_ref(const char *name, const struct object_id *oid,
		      const struct ref_format *format);

/*
 * Push a single ref onto the array; this can be used to construct your own
 * ref_array without using filter_refs().
 */
struct ref_array_item *ref_array_push(struct ref_array *array,
				      const char *refname,
				      const struct object_id *oid);

#endif /*  REF_FILTER_H  */
Commit	Line	Data
	1	#ifndef REF_FILTER_H
	2	#define REF_FILTER_H
	3
	4	#include "sha1-array.h"
	5	#include "refs.h"
	6	#include "commit.h"
	7	#include "parse-options.h"
	8
	9	/* Quoting styles */
	10	#define QUOTE_NONE 0
	11	#define QUOTE_SHELL 1
	12	#define QUOTE_PERL 2
	13	#define QUOTE_PYTHON 4
	14	#define QUOTE_TCL 8
	15
	16	#define FILTER_REFS_INCLUDE_BROKEN 0x0001
	17	#define FILTER_REFS_TAGS 0x0002
	18	#define FILTER_REFS_BRANCHES 0x0004
	19	#define FILTER_REFS_REMOTES 0x0008
	20	#define FILTER_REFS_OTHERS 0x0010
	21	#define FILTER_REFS_ALL (FILTER_REFS_TAGS \| FILTER_REFS_BRANCHES \| \
	22	FILTER_REFS_REMOTES \| FILTER_REFS_OTHERS)
	23	#define FILTER_REFS_DETACHED_HEAD 0x0020
	24	#define FILTER_REFS_KIND_MASK (FILTER_REFS_ALL \| FILTER_REFS_DETACHED_HEAD)
	25
	26	struct atom_value;
	27
	28	struct ref_sorting {
	29	struct ref_sorting *next;
	30	int atom; /* index into used_atom array (internal) */
	31	unsigned reverse : 1,
	32	ignore_case : 1,
	33	version : 1;
	34	};
	35
	36	struct ref_array_item {
	37	struct object_id objectname;
	38	int flag;
	39	unsigned int kind;
	40	const char *symref;
	41	struct commit *commit;
	42	struct atom_value *value;
	43	char refname[FLEX_ARRAY];
	44	};
	45
	46	struct ref_array {
	47	int nr, alloc;
	48	struct ref_array_item **items;
	49	struct rev_info *revs;
	50	};
	51
	52	struct ref_filter {
	53	const char **name_patterns;
	54	struct oid_array points_at;
	55	struct commit_list *with_commit;
	56	struct commit_list *no_commit;
	57
	58	enum {
	59	REF_FILTER_MERGED_NONE = 0,
	60	REF_FILTER_MERGED_INCLUDE,
	61	REF_FILTER_MERGED_OMIT
	62	} merge;
	63	struct commit *merge_commit;
	64
	65	unsigned int with_commit_tag_algo : 1,
	66	match_as_path : 1,
	67	ignore_case : 1,
	68	detached : 1;
	69	unsigned int kind,
	70	lines;
	71	int abbrev,
	72	verbose;
	73	};
	74
	75	struct ref_format {
	76	/*
	77	* Set these to define the format; make sure you call
	78	* verify_ref_format() afterwards to finalize.
	79	*/
	80	const char *format;
	81	int quote_style;
	82	int use_color;
	83
	84	/* Internal state to ref-filter */
	85	int need_color_reset_at_eol;
	86	};
	87
	88	#define REF_FORMAT_INIT { NULL, 0, -1 }
	89
	90	/* Macros for checking --merged and --no-merged options */
	91	#define _OPT_MERGED_NO_MERGED(option, filter, h) \
	92	{ OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
	93	PARSE_OPT_LASTARG_DEFAULT \| PARSE_OPT_NONEG, \
	94	parse_opt_merge_filter, (intptr_t) "HEAD" \
	95	}
	96	#define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
	97	#define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
	98
	99	#define OPT_REF_SORT(var) \
	100	OPT_CALLBACK_F(0, "sort", (var), \
	101	N_("key"), N_("field name to sort on"), \
	102	PARSE_OPT_NONEG, parse_opt_ref_sorting)
	103
	104	/*
	105	* API for filtering a set of refs. Based on the type of refs the user
	106	* has requested, we iterate through those refs and apply filters
	107	* as per the given ref_filter structure and finally store the
	108	* filtered refs in the ref_array structure.
	109	*/
	110	int filter_refs(struct ref_array array, struct ref_filter filter, unsigned int type);
	111	/* Clear all memory allocated to ref_array */
	112	void ref_array_clear(struct ref_array *array);
	113	/* Used to verify if the given format is correct and to parse out the used atoms */
	114	int verify_ref_format(struct ref_format *format);
	115	/* Sort the given ref_array as per the ref_sorting provided */
	116	void ref_array_sort(struct ref_sorting sort, struct ref_array array);
	117	/* Based on the given format and quote_style, fill the strbuf */
	118	int format_ref_array_item(struct ref_array_item *info,
	119	const struct ref_format *format,
	120	struct strbuf *final_buf,
	121	struct strbuf *error_buf);
	122	/* Print the ref using the given format and quote_style */
	123	void show_ref_array_item(struct ref_array_item info, const struct ref_format format);
	124	/* Parse a single sort specifier and add it to the list */
	125	void parse_ref_sorting(struct ref_sorting *sorting_tail, const char atom);
	126	/* Callback function for parsing the sort option */
	127	int parse_opt_ref_sorting(const struct option opt, const char arg, int unset);
	128	/* Default sort option based on refname */
	129	struct ref_sorting *ref_default_sorting(void);
	130	/* Function to parse --merged and --no-merged options */
	131	int parse_opt_merge_filter(const struct option opt, const char arg, int unset);
	132	/* Get the current HEAD's description */
	133	char *get_head_description(void);
	134	/* Set up translated strings in the output. */
	135	void setup_ref_filter_porcelain_msg(void);
	136
	137	/*
	138	* Print a single ref, outside of any ref-filter. Note that the
	139	* name must be a fully qualified refname.
	140	*/
	141	void pretty_print_ref(const char name, const struct object_id oid,
	142	const struct ref_format *format);
	143
	144	/*
	145	* Push a single ref onto the array; this can be used to construct your own
	146	* ref_array without using filter_refs().
	147	*/
	148	struct ref_array_item ref_array_push(struct ref_array array,
	149	const char *refname,
	150	const struct object_id *oid);
	151
	152	#endif /* REF_FILTER_H */