list-objects.con commit doc: group pretty-format.txt placeholders descriptions (4261775)
   1#include "cache.h"
   2#include "tag.h"
   3#include "commit.h"
   4#include "tree.h"
   5#include "blob.h"
   6#include "diff.h"
   7#include "tree-walk.h"
   8#include "revision.h"
   9#include "list-objects.h"
  10#include "list-objects-filter.h"
  11#include "list-objects-filter-options.h"
  12#include "packfile.h"
  13#include "object-store.h"
  14#include "trace.h"
  15
  16struct traversal_context {
  17        struct rev_info *revs;
  18        show_object_fn show_object;
  19        show_commit_fn show_commit;
  20        void *show_data;
  21        filter_object_fn filter_fn;
  22        void *filter_data;
  23};
  24
  25static void process_blob(struct traversal_context *ctx,
  26                         struct blob *blob,
  27                         struct strbuf *path,
  28                         const char *name)
  29{
  30        struct object *obj = &blob->object;
  31        size_t pathlen;
  32        enum list_objects_filter_result r = LOFR_MARK_SEEN | LOFR_DO_SHOW;
  33
  34        if (!ctx->revs->blob_objects)
  35                return;
  36        if (!obj)
  37                die("bad blob object");
  38        if (obj->flags & (UNINTERESTING | SEEN))
  39                return;
  40
  41        /*
  42         * Pre-filter known-missing objects when explicitly requested.
  43         * Otherwise, a missing object error message may be reported
  44         * later (depending on other filtering criteria).
  45         *
  46         * Note that this "--exclude-promisor-objects" pre-filtering
  47         * may cause the actual filter to report an incomplete list
  48         * of missing objects.
  49         */
  50        if (ctx->revs->exclude_promisor_objects &&
  51            !has_object_file(&obj->oid) &&
  52            is_promisor_object(&obj->oid))
  53                return;
  54
  55        pathlen = path->len;
  56        strbuf_addstr(path, name);
  57        if ((obj->flags & NOT_USER_GIVEN) && ctx->filter_fn)
  58                r = ctx->filter_fn(LOFS_BLOB, obj,
  59                                   path->buf, &path->buf[pathlen],
  60                                   ctx->filter_data);
  61        if (r & LOFR_MARK_SEEN)
  62                obj->flags |= SEEN;
  63        if (r & LOFR_DO_SHOW)
  64                ctx->show_object(obj, path->buf, ctx->show_data);
  65        strbuf_setlen(path, pathlen);
  66}
  67
  68/*
  69 * Processing a gitlink entry currently does nothing, since
  70 * we do not recurse into the subproject.
  71 *
  72 * We *could* eventually add a flag that actually does that,
  73 * which would involve:
  74 *  - is the subproject actually checked out?
  75 *  - if so, see if the subproject has already been added
  76 *    to the alternates list, and add it if not.
  77 *  - process the commit (or tag) the gitlink points to
  78 *    recursively.
  79 *
  80 * However, it's unclear whether there is really ever any
  81 * reason to see superprojects and subprojects as such a
  82 * "unified" object pool (potentially resulting in a totally
  83 * humongous pack - avoiding which was the whole point of
  84 * having gitlinks in the first place!).
  85 *
  86 * So for now, there is just a note that we *could* follow
  87 * the link, and how to do it. Whether it necessarily makes
  88 * any sense what-so-ever to ever do that is another issue.
  89 */
  90static void process_gitlink(struct traversal_context *ctx,
  91                            const unsigned char *sha1,
  92                            struct strbuf *path,
  93                            const char *name)
  94{
  95        /* Nothing to do */
  96}
  97
  98static void process_tree(struct traversal_context *ctx,
  99                         struct tree *tree,
 100                         struct strbuf *base,
 101                         const char *name);
 102
 103static void process_tree_contents(struct traversal_context *ctx,
 104                                  struct tree *tree,
 105                                  struct strbuf *base)
 106{
 107        struct tree_desc desc;
 108        struct name_entry entry;
 109        enum interesting match = ctx->revs->diffopt.pathspec.nr == 0 ?
 110                all_entries_interesting : entry_not_interesting;
 111
 112        init_tree_desc(&desc, tree->buffer, tree->size);
 113
 114        while (tree_entry(&desc, &entry)) {
 115                if (match != all_entries_interesting) {
 116                        match = tree_entry_interesting(&entry, base, 0,
 117                                                       &ctx->revs->diffopt.pathspec);
 118                        if (match == all_entries_not_interesting)
 119                                break;
 120                        if (match == entry_not_interesting)
 121                                continue;
 122                }
 123
 124                if (S_ISDIR(entry.mode)) {
 125                        struct tree *t = lookup_tree(the_repository, entry.oid);
 126                        t->object.flags |= NOT_USER_GIVEN;
 127                        process_tree(ctx, t, base, entry.path);
 128                }
 129                else if (S_ISGITLINK(entry.mode))
 130                        process_gitlink(ctx, entry.oid->hash,
 131                                        base, entry.path);
 132                else {
 133                        struct blob *b = lookup_blob(the_repository, entry.oid);
 134                        b->object.flags |= NOT_USER_GIVEN;
 135                        process_blob(ctx, b, base, entry.path);
 136                }
 137        }
 138}
 139
 140static void process_tree(struct traversal_context *ctx,
 141                         struct tree *tree,
 142                         struct strbuf *base,
 143                         const char *name)
 144{
 145        struct object *obj = &tree->object;
 146        struct rev_info *revs = ctx->revs;
 147        int baselen = base->len;
 148        enum list_objects_filter_result r = LOFR_MARK_SEEN | LOFR_DO_SHOW;
 149        int failed_parse;
 150
 151        if (!revs->tree_objects)
 152                return;
 153        if (!obj)
 154                die("bad tree object");
 155        if (obj->flags & (UNINTERESTING | SEEN))
 156                return;
 157
 158        failed_parse = parse_tree_gently(tree, 1);
 159        if (failed_parse) {
 160                if (revs->ignore_missing_links)
 161                        return;
 162
 163                /*
 164                 * Pre-filter known-missing tree objects when explicitly
 165                 * requested.  This may cause the actual filter to report
 166                 * an incomplete list of missing objects.
 167                 */
 168                if (revs->exclude_promisor_objects &&
 169                    is_promisor_object(&obj->oid))
 170                        return;
 171
 172                if (!revs->do_not_die_on_missing_tree)
 173                        die("bad tree object %s", oid_to_hex(&obj->oid));
 174        }
 175
 176        strbuf_addstr(base, name);
 177        if ((obj->flags & NOT_USER_GIVEN) && ctx->filter_fn)
 178                r = ctx->filter_fn(LOFS_BEGIN_TREE, obj,
 179                                   base->buf, &base->buf[baselen],
 180                                   ctx->filter_data);
 181        if (r & LOFR_MARK_SEEN)
 182                obj->flags |= SEEN;
 183        if (r & LOFR_DO_SHOW)
 184                ctx->show_object(obj, base->buf, ctx->show_data);
 185        if (base->len)
 186                strbuf_addch(base, '/');
 187
 188        if (r & LOFR_SKIP_TREE)
 189                trace_printf("Skipping contents of tree %s...\n", base->buf);
 190        else if (!failed_parse)
 191                process_tree_contents(ctx, tree, base);
 192
 193        if ((obj->flags & NOT_USER_GIVEN) && ctx->filter_fn) {
 194                r = ctx->filter_fn(LOFS_END_TREE, obj,
 195                                   base->buf, &base->buf[baselen],
 196                                   ctx->filter_data);
 197                if (r & LOFR_MARK_SEEN)
 198                        obj->flags |= SEEN;
 199                if (r & LOFR_DO_SHOW)
 200                        ctx->show_object(obj, base->buf, ctx->show_data);
 201        }
 202
 203        strbuf_setlen(base, baselen);
 204        free_tree_buffer(tree);
 205}
 206
 207static void mark_edge_parents_uninteresting(struct commit *commit,
 208                                            struct rev_info *revs,
 209                                            show_edge_fn show_edge)
 210{
 211        struct commit_list *parents;
 212
 213        for (parents = commit->parents; parents; parents = parents->next) {
 214                struct commit *parent = parents->item;
 215                if (!(parent->object.flags & UNINTERESTING))
 216                        continue;
 217                mark_tree_uninteresting(revs->repo, get_commit_tree(parent));
 218                if (revs->edge_hint && !(parent->object.flags & SHOWN)) {
 219                        parent->object.flags |= SHOWN;
 220                        show_edge(parent);
 221                }
 222        }
 223}
 224
 225void mark_edges_uninteresting(struct rev_info *revs, show_edge_fn show_edge)
 226{
 227        struct commit_list *list;
 228        int i;
 229
 230        for (list = revs->commits; list; list = list->next) {
 231                struct commit *commit = list->item;
 232
 233                if (commit->object.flags & UNINTERESTING) {
 234                        mark_tree_uninteresting(revs->repo,
 235                                                get_commit_tree(commit));
 236                        if (revs->edge_hint_aggressive && !(commit->object.flags & SHOWN)) {
 237                                commit->object.flags |= SHOWN;
 238                                show_edge(commit);
 239                        }
 240                        continue;
 241                }
 242                mark_edge_parents_uninteresting(commit, revs, show_edge);
 243        }
 244        if (revs->edge_hint_aggressive) {
 245                for (i = 0; i < revs->cmdline.nr; i++) {
 246                        struct object *obj = revs->cmdline.rev[i].item;
 247                        struct commit *commit = (struct commit *)obj;
 248                        if (obj->type != OBJ_COMMIT || !(obj->flags & UNINTERESTING))
 249                                continue;
 250                        mark_tree_uninteresting(revs->repo,
 251                                                get_commit_tree(commit));
 252                        if (!(obj->flags & SHOWN)) {
 253                                obj->flags |= SHOWN;
 254                                show_edge(commit);
 255                        }
 256                }
 257        }
 258}
 259
 260static void add_pending_tree(struct rev_info *revs, struct tree *tree)
 261{
 262        add_pending_object(revs, &tree->object, "");
 263}
 264
 265static void traverse_trees_and_blobs(struct traversal_context *ctx,
 266                                     struct strbuf *base)
 267{
 268        int i;
 269
 270        assert(base->len == 0);
 271
 272        for (i = 0; i < ctx->revs->pending.nr; i++) {
 273                struct object_array_entry *pending = ctx->revs->pending.objects + i;
 274                struct object *obj = pending->item;
 275                const char *name = pending->name;
 276                const char *path = pending->path;
 277                if (obj->flags & (UNINTERESTING | SEEN))
 278                        continue;
 279                if (obj->type == OBJ_TAG) {
 280                        obj->flags |= SEEN;
 281                        ctx->show_object(obj, name, ctx->show_data);
 282                        continue;
 283                }
 284                if (!path)
 285                        path = "";
 286                if (obj->type == OBJ_TREE) {
 287                        process_tree(ctx, (struct tree *)obj, base, path);
 288                        continue;
 289                }
 290                if (obj->type == OBJ_BLOB) {
 291                        process_blob(ctx, (struct blob *)obj, base, path);
 292                        continue;
 293                }
 294                die("unknown pending object %s (%s)",
 295                    oid_to_hex(&obj->oid), name);
 296        }
 297        object_array_clear(&ctx->revs->pending);
 298}
 299
 300static void do_traverse(struct traversal_context *ctx)
 301{
 302        struct commit *commit;
 303        struct strbuf csp; /* callee's scratch pad */
 304        strbuf_init(&csp, PATH_MAX);
 305
 306        while ((commit = get_revision(ctx->revs)) != NULL) {
 307                /*
 308                 * an uninteresting boundary commit may not have its tree
 309                 * parsed yet, but we are not going to show them anyway
 310                 */
 311                if (get_commit_tree(commit)) {
 312                        struct tree *tree = get_commit_tree(commit);
 313                        tree->object.flags |= NOT_USER_GIVEN;
 314                        add_pending_tree(ctx->revs, tree);
 315                }
 316                ctx->show_commit(commit, ctx->show_data);
 317
 318                if (ctx->revs->tree_blobs_in_commit_order)
 319                        /*
 320                         * NEEDSWORK: Adding the tree and then flushing it here
 321                         * needs a reallocation for each commit. Can we pass the
 322                         * tree directory without allocation churn?
 323                         */
 324                        traverse_trees_and_blobs(ctx, &csp);
 325        }
 326        traverse_trees_and_blobs(ctx, &csp);
 327        strbuf_release(&csp);
 328}
 329
 330void traverse_commit_list(struct rev_info *revs,
 331                          show_commit_fn show_commit,
 332                          show_object_fn show_object,
 333                          void *show_data)
 334{
 335        struct traversal_context ctx;
 336        ctx.revs = revs;
 337        ctx.show_commit = show_commit;
 338        ctx.show_object = show_object;
 339        ctx.show_data = show_data;
 340        ctx.filter_fn = NULL;
 341        ctx.filter_data = NULL;
 342        do_traverse(&ctx);
 343}
 344
 345void traverse_commit_list_filtered(
 346        struct list_objects_filter_options *filter_options,
 347        struct rev_info *revs,
 348        show_commit_fn show_commit,
 349        show_object_fn show_object,
 350        void *show_data,
 351        struct oidset *omitted)
 352{
 353        struct traversal_context ctx;
 354        filter_free_fn filter_free_fn = NULL;
 355
 356        ctx.revs = revs;
 357        ctx.show_object = show_object;
 358        ctx.show_commit = show_commit;
 359        ctx.show_data = show_data;
 360        ctx.filter_fn = NULL;
 361
 362        ctx.filter_data = list_objects_filter__init(omitted, filter_options,
 363                                                    &ctx.filter_fn, &filter_free_fn);
 364        do_traverse(&ctx);
 365        if (ctx.filter_data && filter_free_fn)
 366                filter_free_fn(ctx.filter_data);
 367}