[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 0x1
#define FILTER_REFS_ALL 0x2

struct atom_value {
	const char *s;
	unsigned long ul; /* used for sorting when not FIELD_STR */
};

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

struct ref_array_item {
	unsigned char objectname[20];
	int flag;
	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 ref_filter {
	const char **name_patterns;
	struct sha1_array points_at;

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

struct ref_filter_cbdata {
	struct ref_array *array;
	struct ref_filter *filter;
};

/*  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)

/*
 * 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);
/*  Parse format string and sort specifiers */
int parse_ref_filter_atom(const char *atom, const char *ep);
/*  Used to verify if the given format is correct and to parse out the used atoms */
int verify_ref_format(const char *format);
/*  Sort the given ref_array as per the ref_sorting provided */
void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
/*  Print the ref using the given format and quote_style */
void show_ref_array_item(struct ref_array_item *info, const char *format, int quote_style);
/*  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);

#endif /*  REF_FILTER_H  */
Commit	Line	Data
69b1cf91 KN	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
14de7fba KN	16	#define FILTER_REFS_INCLUDE_BROKEN 0x1
	17	#define FILTER_REFS_ALL 0x2
	18
69b1cf91 KN	19	struct atom_value {
	20	const char *s;
	21	unsigned long ul; /* used for sorting when not FIELD_STR */
	22	};
	23
	24	struct ref_sorting {
	25	struct ref_sorting *next;
	26	int atom; /* index into used_atom array (internal) */
	27	unsigned reverse : 1;
	28	};
	29
	30	struct ref_array_item {
	31	unsigned char objectname[20];
	32	int flag;
	33	const char *symref;
35257aa0	34	struct commit *commit;
69b1cf91	35	struct atom_value *value;
1958a6eb	36	char refname[FLEX_ARRAY];
69b1cf91 KN	37	};
	38
	39	struct ref_array {
	40	int nr, alloc;
	41	struct ref_array_item **items;
	42	};
	43
	44	struct ref_filter {
	45	const char **name_patterns;
68411046	46	struct sha1_array points_at;
35257aa0 KN	47
	48	enum {
	49	REF_FILTER_MERGED_NONE = 0,
	50	REF_FILTER_MERGED_INCLUDE,
	51	REF_FILTER_MERGED_OMIT
	52	} merge;
	53	struct commit *merge_commit;
69b1cf91 KN	54	};
	55
	56	struct ref_filter_cbdata {
14de7fba KN	57	struct ref_array *array;
14de7fba KN	58	struct ref_filter *filter;
69b1cf91 KN	59	};
69b1cf91 KN	60
5afcb905 KN	61	/* Macros for checking --merged and --no-merged options */
	62	#define _OPT_MERGED_NO_MERGED(option, filter, h) \
	63	{ OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
	64	PARSE_OPT_LASTARG_DEFAULT \| PARSE_OPT_NONEG, \
	65	parse_opt_merge_filter, (intptr_t) "HEAD" \
	66	}
	67	#define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
	68	#define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
	69
14de7fba KN	70	/*
	71	* API for filtering a set of refs. Based on the type of refs the user
	72	* has requested, we iterate through those refs and apply filters
	73	* as per the given ref_filter structure and finally store the
	74	* filtered refs in the ref_array structure.
	75	*/
	76	int filter_refs(struct ref_array array, struct ref_filter filter, unsigned int type);
69b1cf91 KN	77	/* Clear all memory allocated to ref_array */
	78	void ref_array_clear(struct ref_array *array);
	79	/* Parse format string and sort specifiers */
	80	int parse_ref_filter_atom(const char atom, const char ep);
	81	/* Used to verify if the given format is correct and to parse out the used atoms */
	82	int verify_ref_format(const char *format);
	83	/* Sort the given ref_array as per the ref_sorting provided */
	84	void ref_array_sort(struct ref_sorting sort, struct ref_array array);
	85	/* Print the ref using the given format and quote_style */
	86	void show_ref_array_item(struct ref_array_item info, const char format, int quote_style);
	87	/* Callback function for parsing the sort option */
	88	int parse_opt_ref_sorting(const struct option opt, const char arg, int unset);
	89	/* Default sort option based on refname */
	90	struct ref_sorting *ref_default_sorting(void);
5afcb905 KN	91	/* Function to parse --merged and --no-merged options */
5afcb905 KN	92	int parse_opt_merge_filter(const struct option opt, const char arg, int unset);
69b1cf91 KN	93
69b1cf91 KN	94	#endif /* REF_FILTER_H */