list-objects-filter-options.h

   1 #ifndef LIST_OBJECTS_FILTER_OPTIONS_H
   2 #define LIST_OBJECTS_FILTER_OPTIONS_H
   3
   4 #include "cache.h"
   5 #include "parse-options.h"
   6 #include "string-list.h"
   7
   8 /*
   9  * The list of defined filters for list-objects.
  10  */
  11 enum list_objects_filter_choice {
  12         LOFC_DISABLED = 0,
  13         LOFC_BLOB_NONE,
  14         LOFC_BLOB_LIMIT,
  15         LOFC_TREE_DEPTH,
  16         LOFC_SPARSE_OID,
  17         LOFC_OBJECT_TYPE,
  18         LOFC_COMBINE,
  19         LOFC__COUNT /* must be last */
  20 };
  21
  22 /*
  23  * Returns a configuration key suitable for describing the given object filter,
  24  * e.g.: "blob:none", "combine", etc.
  25  */
  26 const char *list_object_filter_config_name(enum list_objects_filter_choice c);
  27
  28 struct list_objects_filter_options {
  29         /*
  30          * 'filter_spec' is the raw argument value given on the command line
  31          * or protocol request.  (The part after the "--keyword=".)  For
  32          * commands that launch filtering sub-processes, or for communication
  33          * over the network, don't use this value; use the result of
  34          * expand_list_objects_filter_spec() instead.
  35          * To get the raw filter spec given by the user, use the result of
  36          * list_objects_filter_spec().
  37          */
  38         struct string_list filter_spec;
  39
  40         /*
  41          * 'choice' is determined by parsing the filter-spec.  This indicates
  42          * the filtering algorithm to use.
  43          */
  44         enum list_objects_filter_choice choice;
  45
  46         /*
  47          * Choice is LOFC_DISABLED because "--no-filter" was requested.
  48          */
  49         unsigned int no_filter : 1;
  50
  51         /*
  52          * BEGIN choice-specific parsed values from within the filter-spec. Only
  53          * some values will be defined for any given choice.
  54          */
  55
  56         char *sparse_oid_name;
  57         unsigned long blob_limit_value;
  58         unsigned long tree_exclude_depth;
  59         enum object_type object_type;
  60
  61         /* LOFC_COMBINE values */
  62
  63         /* This array contains all the subfilters which this filter combines. */
  64         size_t sub_nr, sub_alloc;
  65         struct list_objects_filter_options *sub;
  66
  67         /*
  68          * END choice-specific parsed values.
  69          */
  70 };
  71
  72 /* Normalized command line arguments */
  73 #define CL_ARG__FILTER "filter"
  74
  75 void list_objects_filter_die_if_populated(
  76         struct list_objects_filter_options *filter_options);
  77
  78 /*
  79  * Parses the filter spec string given by arg and either (1) simply places the
  80  * result in filter_options if it is not yet populated or (2) combines it with
  81  * the filter already in filter_options if it is already populated. In the case
  82  * of (2), the filter specs are combined as if specified with 'combine:'.
  83  *
  84  * Dies and prints a user-facing message if an error occurs.
  85  */
  86 void parse_list_objects_filter(
  87         struct list_objects_filter_options *filter_options,
  88         const char *arg);
  89
  90 int opt_parse_list_objects_filter(const struct option *opt,
  91                                   const char *arg, int unset);
  92
  93 #define OPT_PARSE_LIST_OBJECTS_FILTER(fo) \
  94         OPT_CALLBACK(0, CL_ARG__FILTER, fo, N_("args"), \
  95           N_("object filtering"), \
  96           opt_parse_list_objects_filter)
  97
  98 /*
  99  * Translates abbreviated numbers in the filter's filter_spec into their
 100  * fully-expanded forms (e.g., "limit:blob=1k" becomes "limit:blob=1024").
 101  * Returns a string owned by the list_objects_filter_options object.
 102  *
 103  * This form should be used instead of the raw list_objects_filter_spec()
 104  * value when communicating with a remote process or subprocess.
 105  */
 106 const char *expand_list_objects_filter_spec(
 107         struct list_objects_filter_options *filter);
 108
 109 /*
 110  * Returns the filter spec string more or less in the form as the user
 111  * entered it. This form of the filter_spec can be used in user-facing
 112  * messages.  Returns a string owned by the list_objects_filter_options
 113  * object.
 114  */
 115 const char *list_objects_filter_spec(
 116         struct list_objects_filter_options *filter);
 117
 118 void list_objects_filter_release(
 119         struct list_objects_filter_options *filter_options);
 120
 121 static inline void list_objects_filter_set_no_filter(
 122         struct list_objects_filter_options *filter_options)
 123 {
 124         list_objects_filter_release(filter_options);
 125         filter_options->no_filter = 1;
 126 }
 127
 128 void partial_clone_register(
 129         const char *remote,
 130         struct list_objects_filter_options *filter_options);
 131 void partial_clone_get_default_filter_spec(
 132         struct list_objects_filter_options *filter_options,
 133         const char *remote);
 134
 135 #endif /* LIST_OBJECTS_FILTER_OPTIONS_H */