[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_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;

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

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,
	13	LOFC_SPARSE_OID,
	14	LOFC_SPARSE_PATH,
	15	LOFC__COUNT /* must be last */
	16	};
	17
	18	struct list_objects_filter_options {
	19	/*
	20	* 'filter_spec' is the raw argument value given on the command line
	21	* or protocol request. (The part after the "--keyword=".) For
	22	* commands that launch filtering sub-processes, this value should be
	23	* passed to them as received by the current process.
	24	*/
	25	char *filter_spec;
	26
	27	/*
	28	* 'choice' is determined by parsing the filter-spec. This indicates
	29	* the filtering algorithm to use.
	30	*/
	31	enum list_objects_filter_choice choice;
	32
	33	/*
	34	* Parsed values (fields) from within the filter-spec. These are
	35	* choice-specific; not all values will be defined for any given
	36	* choice.
	37	*/
	38	struct object_id *sparse_oid_value;
	39	char *sparse_path_value;
	40	unsigned long blob_limit_value;
	41	};
	42
	43	/* Normalized command line arguments */
	44	#define CL_ARG__FILTER "filter"
	45
	46	int parse_list_objects_filter(
	47	struct list_objects_filter_options *filter_options,
	48	const char *arg);
	49
	50	int opt_parse_list_objects_filter(const struct option *opt,
	51	const char *arg, int unset);
	52
	53	#define OPT_PARSE_LIST_OBJECTS_FILTER(fo) \
	54	{ OPTION_CALLBACK, 0, CL_ARG__FILTER, fo, N_("args"), \
4875c979	55	N_("object filtering"), 0, \
25ec7bca JH	56	opt_parse_list_objects_filter }
25ec7bca JH	57
4875c979 JH	58	void list_objects_filter_release(
	59	struct list_objects_filter_options *filter_options);
	60
1e1e39b3 JH	61	void partial_clone_register(
	62	const char *remote,
	63	const struct list_objects_filter_options *filter_options);
	64	void partial_clone_get_default_filter_spec(
	65	struct list_objects_filter_options *filter_options);
	66
25ec7bca	67	#endif /* LIST_OBJECTS_FILTER_OPTIONS_H */