[thirdparty/git.git] / list-objects-filter-options.h

#ifndef LIST_OBJECTS_FILTER_OPTIONS_H
#define LIST_OBJECTS_FILTER_OPTIONS_H

#include "parse-options.h"

/*
 * The list of defined filters for list-objects.
 */
enum list_objects_filter_choice {
	LOFC_DISABLED = 0,
	LOFC_BLOB_NONE,
	LOFC_BLOB_LIMIT,
	LOFC_TREE_NONE,
	LOFC_SPARSE_OID,
	LOFC_SPARSE_PATH,
	LOFC__COUNT /* must be last */
};

struct list_objects_filter_options {
	/*
	 * 'filter_spec' is the raw argument value given on the command line
	 * or protocol request.  (The part after the "--keyword=".)  For
	 * commands that launch filtering sub-processes, this value should be
	 * passed to them as received by the current process.
	 */
	char *filter_spec;

	/*
	 * 'choice' is determined by parsing the filter-spec.  This indicates
	 * the filtering algorithm to use.
	 */
	enum list_objects_filter_choice choice;

	/*
	 * Choice is LOFC_DISABLED because "--no-filter" was requested.
	 */
	unsigned int no_filter : 1;

	/*
	 * Parsed values (fields) from within the filter-spec.  These are
	 * choice-specific; not all values will be defined for any given
	 * choice.
	 */
	struct object_id *sparse_oid_value;
	char *sparse_path_value;
	unsigned long blob_limit_value;
};

/* Normalized command line arguments */
#define CL_ARG__FILTER "filter"

int parse_list_objects_filter(
	struct list_objects_filter_options *filter_options,
	const char *arg);

int opt_parse_list_objects_filter(const struct option *opt,
				  const char *arg, int unset);

#define OPT_PARSE_LIST_OBJECTS_FILTER(fo) \
	{ OPTION_CALLBACK, 0, CL_ARG__FILTER, fo, N_("args"), \
	  N_("object filtering"), 0, \
	  opt_parse_list_objects_filter }

void list_objects_filter_release(
	struct list_objects_filter_options *filter_options);

static inline void list_objects_filter_set_no_filter(
	struct list_objects_filter_options *filter_options)
{
	list_objects_filter_release(filter_options);
	filter_options->no_filter = 1;
}

void partial_clone_register(
	const char *remote,
	const struct list_objects_filter_options *filter_options);
void partial_clone_get_default_filter_spec(
	struct list_objects_filter_options *filter_options);

#endif /* LIST_OBJECTS_FILTER_OPTIONS_H */
Commit	Line	Data
25ec7bca JH	1	#ifndef LIST_OBJECTS_FILTER_OPTIONS_H
	2	#define LIST_OBJECTS_FILTER_OPTIONS_H
	3
	4	#include "parse-options.h"
	5
	6	/*
	7	* The list of defined filters for list-objects.
	8	*/
	9	enum list_objects_filter_choice {
	10	LOFC_DISABLED = 0,
	11	LOFC_BLOB_NONE,
	12	LOFC_BLOB_LIMIT,
bc5975d2	13	LOFC_TREE_NONE,
25ec7bca JH	14	LOFC_SPARSE_OID,
	15	LOFC_SPARSE_PATH,
	16	LOFC__COUNT /* must be last */
	17	};
	18
	19	struct list_objects_filter_options {
	20	/*
	21	* 'filter_spec' is the raw argument value given on the command line
	22	* or protocol request. (The part after the "--keyword=".) For
	23	* commands that launch filtering sub-processes, this value should be
	24	* passed to them as received by the current process.
	25	*/
	26	char *filter_spec;
	27
	28	/*
	29	* 'choice' is determined by parsing the filter-spec. This indicates
	30	* the filtering algorithm to use.
	31	*/
	32	enum list_objects_filter_choice choice;
	33
aa57b871 JH	34	/*
	35	* Choice is LOFC_DISABLED because "--no-filter" was requested.
	36	*/
	37	unsigned int no_filter : 1;
	38
25ec7bca JH	39	/*
	40	* Parsed values (fields) from within the filter-spec. These are
	41	* choice-specific; not all values will be defined for any given
	42	* choice.
	43	*/
	44	struct object_id *sparse_oid_value;
	45	char *sparse_path_value;
	46	unsigned long blob_limit_value;
	47	};
	48
	49	/* Normalized command line arguments */
	50	#define CL_ARG__FILTER "filter"
	51
	52	int parse_list_objects_filter(
	53	struct list_objects_filter_options *filter_options,
	54	const char *arg);
	55
	56	int opt_parse_list_objects_filter(const struct option *opt,
	57	const char *arg, int unset);
	58
	59	#define OPT_PARSE_LIST_OBJECTS_FILTER(fo) \
	60	{ OPTION_CALLBACK, 0, CL_ARG__FILTER, fo, N_("args"), \
4875c979	61	N_("object filtering"), 0, \
25ec7bca JH	62	opt_parse_list_objects_filter }
25ec7bca JH	63
4875c979 JH	64	void list_objects_filter_release(
	65	struct list_objects_filter_options *filter_options);
	66
aa57b871 JH	67	static inline void list_objects_filter_set_no_filter(
	68	struct list_objects_filter_options *filter_options)
	69	{
	70	list_objects_filter_release(filter_options);
	71	filter_options->no_filter = 1;
	72	}
	73
1e1e39b3 JH	74	void partial_clone_register(
	75	const char *remote,
	76	const struct list_objects_filter_options *filter_options);
	77	void partial_clone_get_default_filter_spec(
	78	struct list_objects_filter_options *filter_options);
	79
25ec7bca	80	#endif /* LIST_OBJECTS_FILTER_OPTIONS_H */