| #ifndef LIST_OBJECTS_FILTER_OPTIONS_H |
| #define LIST_OBJECTS_FILTER_OPTIONS_H |
| |
| #include "cache.h" |
| #include "parse-options.h" |
| #include "string-list.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_DEPTH, |
| LOFC_SPARSE_OID, |
| LOFC_OBJECT_TYPE, |
| LOFC_COMBINE, |
| LOFC__COUNT /* must be last */ |
| }; |
| |
| /* |
| * Returns a configuration key suitable for describing the given object filter, |
| * e.g.: "blob:none", "combine", etc. |
| */ |
| const char *list_object_filter_config_name(enum list_objects_filter_choice c); |
| |
| 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, or for communication |
| * over the network, don't use this value; use the result of |
| * expand_list_objects_filter_spec() instead. |
| * To get the raw filter spec given by the user, use the result of |
| * list_objects_filter_spec(). |
| */ |
| struct string_list 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; |
| |
| /* |
| * BEGIN choice-specific parsed values from within the filter-spec. Only |
| * some values will be defined for any given choice. |
| */ |
| |
| char *sparse_oid_name; |
| unsigned long blob_limit_value; |
| unsigned long tree_exclude_depth; |
| enum object_type object_type; |
| |
| /* LOFC_COMBINE values */ |
| |
| /* This array contains all the subfilters which this filter combines. */ |
| size_t sub_nr, sub_alloc; |
| struct list_objects_filter_options *sub; |
| |
| /* |
| * END choice-specific parsed values. |
| */ |
| }; |
| |
| /* Normalized command line arguments */ |
| #define CL_ARG__FILTER "filter" |
| |
| void list_objects_filter_die_if_populated( |
| struct list_objects_filter_options *filter_options); |
| |
| /* |
| * Parses the filter spec string given by arg and either (1) simply places the |
| * result in filter_options if it is not yet populated or (2) combines it with |
| * the filter already in filter_options if it is already populated. In the case |
| * of (2), the filter specs are combined as if specified with 'combine:'. |
| * |
| * Dies and prints a user-facing message if an error occurs. |
| */ |
| void 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) \ |
| OPT_CALLBACK(0, CL_ARG__FILTER, fo, N_("args"), \ |
| N_("object filtering"), \ |
| opt_parse_list_objects_filter) |
| |
| /* |
| * Translates abbreviated numbers in the filter's filter_spec into their |
| * fully-expanded forms (e.g., "limit:blob=1k" becomes "limit:blob=1024"). |
| * Returns a string owned by the list_objects_filter_options object. |
| * |
| * This form should be used instead of the raw list_objects_filter_spec() |
| * value when communicating with a remote process or subprocess. |
| */ |
| const char *expand_list_objects_filter_spec( |
| struct list_objects_filter_options *filter); |
| |
| /* |
| * Returns the filter spec string more or less in the form as the user |
| * entered it. This form of the filter_spec can be used in user-facing |
| * messages. Returns a string owned by the list_objects_filter_options |
| * object. |
| */ |
| const char *list_objects_filter_spec( |
| struct list_objects_filter_options *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, |
| struct list_objects_filter_options *filter_options); |
| void partial_clone_get_default_filter_spec( |
| struct list_objects_filter_options *filter_options, |
| const char *remote); |
| |
| #endif /* LIST_OBJECTS_FILTER_OPTIONS_H */ |