list-objects-filter-options.con commit t3000 (ls-files -o): widen description to reflect current tests (d8083e4)
   1#include "cache.h"
   2#include "commit.h"
   3#include "config.h"
   4#include "revision.h"
   5#include "argv-array.h"
   6#include "list-objects.h"
   7#include "list-objects-filter.h"
   8#include "list-objects-filter-options.h"
   9
  10/*
  11 * Parse value of the argument to the "filter" keyword.
  12 * On the command line this looks like:
  13 *       --filter=<arg>
  14 * and in the pack protocol as:
  15 *       "filter" SP <arg>
  16 *
  17 * The filter keyword will be used by many commands.
  18 * See Documentation/rev-list-options.txt for allowed values for <arg>.
  19 *
  20 * Capture the given arg as the "filter_spec".  This can be forwarded to
  21 * subordinate commands when necessary (although it's better to pass it through
  22 * expand_list_objects_filter_spec() first).  We also "intern" the arg for the
  23 * convenience of the current command.
  24 */
  25static int gently_parse_list_objects_filter(
  26        struct list_objects_filter_options *filter_options,
  27        const char *arg,
  28        struct strbuf *errbuf)
  29{
  30        const char *v0;
  31
  32        if (filter_options->choice) {
  33                if (errbuf) {
  34                        strbuf_addstr(
  35                                errbuf,
  36                                _("multiple filter-specs cannot be combined"));
  37                }
  38                return 1;
  39        }
  40
  41        filter_options->filter_spec = strdup(arg);
  42
  43        if (!strcmp(arg, "blob:none")) {
  44                filter_options->choice = LOFC_BLOB_NONE;
  45                return 0;
  46
  47        } else if (skip_prefix(arg, "blob:limit=", &v0)) {
  48                if (git_parse_ulong(v0, &filter_options->blob_limit_value)) {
  49                        filter_options->choice = LOFC_BLOB_LIMIT;
  50                        return 0;
  51                }
  52
  53        } else if (skip_prefix(arg, "tree:", &v0)) {
  54                if (!git_parse_ulong(v0, &filter_options->tree_exclude_depth)) {
  55                        if (errbuf) {
  56                                strbuf_addstr(
  57                                        errbuf,
  58                                        _("expected 'tree:<depth>'"));
  59                        }
  60                        return 1;
  61                }
  62                filter_options->choice = LOFC_TREE_DEPTH;
  63                return 0;
  64
  65        } else if (skip_prefix(arg, "sparse:oid=", &v0)) {
  66                struct object_context oc;
  67                struct object_id sparse_oid;
  68
  69                /*
  70                 * Try to parse <oid-expression> into an OID for the current
  71                 * command, but DO NOT complain if we don't have the blob or
  72                 * ref locally.
  73                 */
  74                if (!get_oid_with_context(the_repository, v0, GET_OID_BLOB,
  75                                          &sparse_oid, &oc))
  76                        filter_options->sparse_oid_value = oiddup(&sparse_oid);
  77                filter_options->choice = LOFC_SPARSE_OID;
  78                return 0;
  79
  80        } else if (skip_prefix(arg, "sparse:path=", &v0)) {
  81                filter_options->choice = LOFC_SPARSE_PATH;
  82                filter_options->sparse_path_value = strdup(v0);
  83                return 0;
  84        }
  85
  86        if (errbuf)
  87                strbuf_addf(errbuf, "invalid filter-spec '%s'", arg);
  88
  89        memset(filter_options, 0, sizeof(*filter_options));
  90        return 1;
  91}
  92
  93int parse_list_objects_filter(struct list_objects_filter_options *filter_options,
  94                              const char *arg)
  95{
  96        struct strbuf buf = STRBUF_INIT;
  97        if (gently_parse_list_objects_filter(filter_options, arg, &buf))
  98                die("%s", buf.buf);
  99        return 0;
 100}
 101
 102int opt_parse_list_objects_filter(const struct option *opt,
 103                                  const char *arg, int unset)
 104{
 105        struct list_objects_filter_options *filter_options = opt->value;
 106
 107        if (unset || !arg) {
 108                list_objects_filter_set_no_filter(filter_options);
 109                return 0;
 110        }
 111
 112        return parse_list_objects_filter(filter_options, arg);
 113}
 114
 115void expand_list_objects_filter_spec(
 116        const struct list_objects_filter_options *filter,
 117        struct strbuf *expanded_spec)
 118{
 119        strbuf_init(expanded_spec, strlen(filter->filter_spec));
 120        if (filter->choice == LOFC_BLOB_LIMIT)
 121                strbuf_addf(expanded_spec, "blob:limit=%lu",
 122                            filter->blob_limit_value);
 123        else if (filter->choice == LOFC_TREE_DEPTH)
 124                strbuf_addf(expanded_spec, "tree:%lu",
 125                            filter->tree_exclude_depth);
 126        else
 127                strbuf_addstr(expanded_spec, filter->filter_spec);
 128}
 129
 130void list_objects_filter_release(
 131        struct list_objects_filter_options *filter_options)
 132{
 133        free(filter_options->filter_spec);
 134        free(filter_options->sparse_oid_value);
 135        free(filter_options->sparse_path_value);
 136        memset(filter_options, 0, sizeof(*filter_options));
 137}
 138
 139void partial_clone_register(
 140        const char *remote,
 141        const struct list_objects_filter_options *filter_options)
 142{
 143        /*
 144         * Record the name of the partial clone remote in the
 145         * config and in the global variable -- the latter is
 146         * used throughout to indicate that partial clone is
 147         * enabled and to expect missing objects.
 148         */
 149        if (repository_format_partial_clone &&
 150            *repository_format_partial_clone &&
 151            strcmp(remote, repository_format_partial_clone))
 152                die(_("cannot change partial clone promisor remote"));
 153
 154        git_config_set("core.repositoryformatversion", "1");
 155        git_config_set("extensions.partialclone", remote);
 156
 157        repository_format_partial_clone = xstrdup(remote);
 158
 159        /*
 160         * Record the initial filter-spec in the config as
 161         * the default for subsequent fetches from this remote.
 162         */
 163        core_partial_clone_filter_default =
 164                xstrdup(filter_options->filter_spec);
 165        git_config_set("core.partialclonefilter",
 166                       core_partial_clone_filter_default);
 167}
 168
 169void partial_clone_get_default_filter_spec(
 170        struct list_objects_filter_options *filter_options)
 171{
 172        /*
 173         * Parse default value, but silently ignore it if it is invalid.
 174         */
 175        if (!core_partial_clone_filter_default)
 176                return;
 177        gently_parse_list_objects_filter(filter_options,
 178                                         core_partial_clone_filter_default,
 179                                         NULL);
 180}