builtin / ls-files.con commit Merge branch 'nd/unpack-entry-optim-in-pack-objects' (87bcf14)
   1/*
   2 * This merges the file listing in the directory cache index
   3 * with the actual working directory list, and shows different
   4 * combinations of the two.
   5 *
   6 * Copyright (C) Linus Torvalds, 2005
   7 */
   8#include "cache.h"
   9#include "quote.h"
  10#include "dir.h"
  11#include "builtin.h"
  12#include "tree.h"
  13#include "parse-options.h"
  14#include "resolve-undo.h"
  15#include "string-list.h"
  16#include "pathspec.h"
  17
  18static int abbrev;
  19static int show_deleted;
  20static int show_cached;
  21static int show_others;
  22static int show_stage;
  23static int show_unmerged;
  24static int show_resolve_undo;
  25static int show_modified;
  26static int show_killed;
  27static int show_valid_bit;
  28static int line_terminator = '\n';
  29static int debug_mode;
  30
  31static const char *prefix;
  32static int max_prefix_len;
  33static int prefix_len;
  34static struct pathspec pathspec;
  35static int error_unmatch;
  36static char *ps_matched;
  37static const char *with_tree;
  38static int exc_given;
  39static int exclude_args;
  40
  41static const char *tag_cached = "";
  42static const char *tag_unmerged = "";
  43static const char *tag_removed = "";
  44static const char *tag_other = "";
  45static const char *tag_killed = "";
  46static const char *tag_modified = "";
  47static const char *tag_skip_worktree = "";
  48static const char *tag_resolve_undo = "";
  49
  50static void write_name(const char *name)
  51{
  52        /*
  53         * With "--full-name", prefix_len=0; this caller needs to pass
  54         * an empty string in that case (a NULL is good for "").
  55         */
  56        write_name_quoted_relative(name, prefix_len ? prefix : NULL,
  57                                   stdout, line_terminator);
  58}
  59
  60static void show_dir_entry(const char *tag, struct dir_entry *ent)
  61{
  62        int len = max_prefix_len;
  63
  64        if (len >= ent->len)
  65                die("git ls-files: internal error - directory entry not superset of prefix");
  66
  67        if (!match_pathspec_depth(&pathspec, ent->name, ent->len, len, ps_matched))
  68                return;
  69
  70        fputs(tag, stdout);
  71        write_name(ent->name);
  72}
  73
  74static void show_other_files(struct dir_struct *dir)
  75{
  76        int i;
  77
  78        for (i = 0; i < dir->nr; i++) {
  79                struct dir_entry *ent = dir->entries[i];
  80                if (!cache_name_is_other(ent->name, ent->len))
  81                        continue;
  82                show_dir_entry(tag_other, ent);
  83        }
  84}
  85
  86static void show_killed_files(struct dir_struct *dir)
  87{
  88        int i;
  89        for (i = 0; i < dir->nr; i++) {
  90                struct dir_entry *ent = dir->entries[i];
  91                char *cp, *sp;
  92                int pos, len, killed = 0;
  93
  94                for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
  95                        sp = strchr(cp, '/');
  96                        if (!sp) {
  97                                /* If ent->name is prefix of an entry in the
  98                                 * cache, it will be killed.
  99                                 */
 100                                pos = cache_name_pos(ent->name, ent->len);
 101                                if (0 <= pos)
 102                                        die("bug in show-killed-files");
 103                                pos = -pos - 1;
 104                                while (pos < active_nr &&
 105                                       ce_stage(active_cache[pos]))
 106                                        pos++; /* skip unmerged */
 107                                if (active_nr <= pos)
 108                                        break;
 109                                /* pos points at a name immediately after
 110                                 * ent->name in the cache.  Does it expect
 111                                 * ent->name to be a directory?
 112                                 */
 113                                len = ce_namelen(active_cache[pos]);
 114                                if ((ent->len < len) &&
 115                                    !strncmp(active_cache[pos]->name,
 116                                             ent->name, ent->len) &&
 117                                    active_cache[pos]->name[ent->len] == '/')
 118                                        killed = 1;
 119                                break;
 120                        }
 121                        if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
 122                                /* If any of the leading directories in
 123                                 * ent->name is registered in the cache,
 124                                 * ent->name will be killed.
 125                                 */
 126                                killed = 1;
 127                                break;
 128                        }
 129                }
 130                if (killed)
 131                        show_dir_entry(tag_killed, dir->entries[i]);
 132        }
 133}
 134
 135static void show_ce_entry(const char *tag, const struct cache_entry *ce)
 136{
 137        int len = max_prefix_len;
 138
 139        if (len >= ce_namelen(ce))
 140                die("git ls-files: internal error - cache entry not superset of prefix");
 141
 142        if (!match_pathspec_depth(&pathspec, ce->name, ce_namelen(ce), len, ps_matched))
 143                return;
 144
 145        if (tag && *tag && show_valid_bit &&
 146            (ce->ce_flags & CE_VALID)) {
 147                static char alttag[4];
 148                memcpy(alttag, tag, 3);
 149                if (isalpha(tag[0]))
 150                        alttag[0] = tolower(tag[0]);
 151                else if (tag[0] == '?')
 152                        alttag[0] = '!';
 153                else {
 154                        alttag[0] = 'v';
 155                        alttag[1] = tag[0];
 156                        alttag[2] = ' ';
 157                        alttag[3] = 0;
 158                }
 159                tag = alttag;
 160        }
 161
 162        if (!show_stage) {
 163                fputs(tag, stdout);
 164        } else {
 165                printf("%s%06o %s %d\t",
 166                       tag,
 167                       ce->ce_mode,
 168                       find_unique_abbrev(ce->sha1,abbrev),
 169                       ce_stage(ce));
 170        }
 171        write_name(ce->name);
 172        if (debug_mode) {
 173                const struct stat_data *sd = &ce->ce_stat_data;
 174
 175                printf("  ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
 176                printf("  mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
 177                printf("  dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
 178                printf("  uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
 179                printf("  size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
 180        }
 181}
 182
 183static void show_ru_info(void)
 184{
 185        struct string_list_item *item;
 186
 187        if (!the_index.resolve_undo)
 188                return;
 189
 190        for_each_string_list_item(item, the_index.resolve_undo) {
 191                const char *path = item->string;
 192                struct resolve_undo_info *ui = item->util;
 193                int i, len;
 194
 195                len = strlen(path);
 196                if (len < max_prefix_len)
 197                        continue; /* outside of the prefix */
 198                if (!match_pathspec_depth(&pathspec, path, len, max_prefix_len, ps_matched))
 199                        continue; /* uninterested */
 200                for (i = 0; i < 3; i++) {
 201                        if (!ui->mode[i])
 202                                continue;
 203                        printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
 204                               find_unique_abbrev(ui->sha1[i], abbrev),
 205                               i + 1);
 206                        write_name(path);
 207                }
 208        }
 209}
 210
 211static int ce_excluded(struct dir_struct *dir, const struct cache_entry *ce)
 212{
 213        int dtype = ce_to_dtype(ce);
 214        return is_excluded(dir, ce->name, &dtype);
 215}
 216
 217static void show_files(struct dir_struct *dir)
 218{
 219        int i;
 220
 221        /* For cached/deleted files we don't need to even do the readdir */
 222        if (show_others || show_killed) {
 223                if (!show_others)
 224                        dir->flags |= DIR_COLLECT_KILLED_ONLY;
 225                fill_directory(dir, &pathspec);
 226                if (show_others)
 227                        show_other_files(dir);
 228                if (show_killed)
 229                        show_killed_files(dir);
 230        }
 231        if (show_cached || show_stage) {
 232                for (i = 0; i < active_nr; i++) {
 233                        const struct cache_entry *ce = active_cache[i];
 234                        if ((dir->flags & DIR_SHOW_IGNORED) &&
 235                            !ce_excluded(dir, ce))
 236                                continue;
 237                        if (show_unmerged && !ce_stage(ce))
 238                                continue;
 239                        if (ce->ce_flags & CE_UPDATE)
 240                                continue;
 241                        show_ce_entry(ce_stage(ce) ? tag_unmerged :
 242                                (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
 243                }
 244        }
 245        if (show_deleted || show_modified) {
 246                for (i = 0; i < active_nr; i++) {
 247                        const struct cache_entry *ce = active_cache[i];
 248                        struct stat st;
 249                        int err;
 250                        if ((dir->flags & DIR_SHOW_IGNORED) &&
 251                            !ce_excluded(dir, ce))
 252                                continue;
 253                        if (ce->ce_flags & CE_UPDATE)
 254                                continue;
 255                        if (ce_skip_worktree(ce))
 256                                continue;
 257                        err = lstat(ce->name, &st);
 258                        if (show_deleted && err)
 259                                show_ce_entry(tag_removed, ce);
 260                        if (show_modified && ce_modified(ce, &st, 0))
 261                                show_ce_entry(tag_modified, ce);
 262                }
 263        }
 264}
 265
 266/*
 267 * Prune the index to only contain stuff starting with "prefix"
 268 */
 269static void prune_cache(const char *prefix)
 270{
 271        int pos = cache_name_pos(prefix, max_prefix_len);
 272        unsigned int first, last;
 273
 274        if (pos < 0)
 275                pos = -pos-1;
 276        memmove(active_cache, active_cache + pos,
 277                (active_nr - pos) * sizeof(struct cache_entry *));
 278        active_nr -= pos;
 279        first = 0;
 280        last = active_nr;
 281        while (last > first) {
 282                int next = (last + first) >> 1;
 283                const struct cache_entry *ce = active_cache[next];
 284                if (!strncmp(ce->name, prefix, max_prefix_len)) {
 285                        first = next+1;
 286                        continue;
 287                }
 288                last = next;
 289        }
 290        active_nr = last;
 291}
 292
 293/*
 294 * Read the tree specified with --with-tree option
 295 * (typically, HEAD) into stage #1 and then
 296 * squash them down to stage #0.  This is used for
 297 * --error-unmatch to list and check the path patterns
 298 * that were given from the command line.  We are not
 299 * going to write this index out.
 300 */
 301void overlay_tree_on_cache(const char *tree_name, const char *prefix)
 302{
 303        struct tree *tree;
 304        unsigned char sha1[20];
 305        struct pathspec pathspec;
 306        struct cache_entry *last_stage0 = NULL;
 307        int i;
 308
 309        if (get_sha1(tree_name, sha1))
 310                die("tree-ish %s not found.", tree_name);
 311        tree = parse_tree_indirect(sha1);
 312        if (!tree)
 313                die("bad tree-ish %s", tree_name);
 314
 315        /* Hoist the unmerged entries up to stage #3 to make room */
 316        for (i = 0; i < active_nr; i++) {
 317                struct cache_entry *ce = active_cache[i];
 318                if (!ce_stage(ce))
 319                        continue;
 320                ce->ce_flags |= CE_STAGEMASK;
 321        }
 322
 323        if (prefix) {
 324                static const char *(matchbuf[1]);
 325                matchbuf[0] = NULL;
 326                parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
 327                               PATHSPEC_PREFER_CWD, prefix, matchbuf);
 328        } else
 329                memset(&pathspec, 0, sizeof(pathspec));
 330        if (read_tree(tree, 1, &pathspec))
 331                die("unable to read tree entries %s", tree_name);
 332
 333        for (i = 0; i < active_nr; i++) {
 334                struct cache_entry *ce = active_cache[i];
 335                switch (ce_stage(ce)) {
 336                case 0:
 337                        last_stage0 = ce;
 338                        /* fallthru */
 339                default:
 340                        continue;
 341                case 1:
 342                        /*
 343                         * If there is stage #0 entry for this, we do not
 344                         * need to show it.  We use CE_UPDATE bit to mark
 345                         * such an entry.
 346                         */
 347                        if (last_stage0 &&
 348                            !strcmp(last_stage0->name, ce->name))
 349                                ce->ce_flags |= CE_UPDATE;
 350                }
 351        }
 352}
 353
 354int report_path_error(const char *ps_matched,
 355                      const struct pathspec *pathspec,
 356                      const char *prefix)
 357{
 358        /*
 359         * Make sure all pathspec matched; otherwise it is an error.
 360         */
 361        struct strbuf sb = STRBUF_INIT;
 362        int num, errors = 0;
 363        for (num = 0; num < pathspec->nr; num++) {
 364                int other, found_dup;
 365
 366                if (ps_matched[num])
 367                        continue;
 368                /*
 369                 * The caller might have fed identical pathspec
 370                 * twice.  Do not barf on such a mistake.
 371                 * FIXME: parse_pathspec should have eliminated
 372                 * duplicate pathspec.
 373                 */
 374                for (found_dup = other = 0;
 375                     !found_dup && other < pathspec->nr;
 376                     other++) {
 377                        if (other == num || !ps_matched[other])
 378                                continue;
 379                        if (!strcmp(pathspec->items[other].original,
 380                                    pathspec->items[num].original))
 381                                /*
 382                                 * Ok, we have a match already.
 383                                 */
 384                                found_dup = 1;
 385                }
 386                if (found_dup)
 387                        continue;
 388
 389                error("pathspec '%s' did not match any file(s) known to git.",
 390                      pathspec->items[num].original);
 391                errors++;
 392        }
 393        strbuf_release(&sb);
 394        return errors;
 395}
 396
 397static const char * const ls_files_usage[] = {
 398        N_("git ls-files [options] [<file>...]"),
 399        NULL
 400};
 401
 402static int option_parse_z(const struct option *opt,
 403                          const char *arg, int unset)
 404{
 405        line_terminator = unset ? '\n' : '\0';
 406
 407        return 0;
 408}
 409
 410static int option_parse_exclude(const struct option *opt,
 411                                const char *arg, int unset)
 412{
 413        struct string_list *exclude_list = opt->value;
 414
 415        exc_given = 1;
 416        string_list_append(exclude_list, arg);
 417
 418        return 0;
 419}
 420
 421static int option_parse_exclude_from(const struct option *opt,
 422                                     const char *arg, int unset)
 423{
 424        struct dir_struct *dir = opt->value;
 425
 426        exc_given = 1;
 427        add_excludes_from_file(dir, arg);
 428
 429        return 0;
 430}
 431
 432static int option_parse_exclude_standard(const struct option *opt,
 433                                         const char *arg, int unset)
 434{
 435        struct dir_struct *dir = opt->value;
 436
 437        exc_given = 1;
 438        setup_standard_excludes(dir);
 439
 440        return 0;
 441}
 442
 443int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
 444{
 445        int require_work_tree = 0, show_tag = 0, i;
 446        const char *max_prefix;
 447        struct dir_struct dir;
 448        struct exclude_list *el;
 449        struct string_list exclude_list = STRING_LIST_INIT_NODUP;
 450        struct option builtin_ls_files_options[] = {
 451                { OPTION_CALLBACK, 'z', NULL, NULL, NULL,
 452                        N_("paths are separated with NUL character"),
 453                        PARSE_OPT_NOARG, option_parse_z },
 454                OPT_BOOL('t', NULL, &show_tag,
 455                        N_("identify the file status with tags")),
 456                OPT_BOOL('v', NULL, &show_valid_bit,
 457                        N_("use lowercase letters for 'assume unchanged' files")),
 458                OPT_BOOL('c', "cached", &show_cached,
 459                        N_("show cached files in the output (default)")),
 460                OPT_BOOL('d', "deleted", &show_deleted,
 461                        N_("show deleted files in the output")),
 462                OPT_BOOL('m', "modified", &show_modified,
 463                        N_("show modified files in the output")),
 464                OPT_BOOL('o', "others", &show_others,
 465                        N_("show other files in the output")),
 466                OPT_BIT('i', "ignored", &dir.flags,
 467                        N_("show ignored files in the output"),
 468                        DIR_SHOW_IGNORED),
 469                OPT_BOOL('s', "stage", &show_stage,
 470                        N_("show staged contents' object name in the output")),
 471                OPT_BOOL('k', "killed", &show_killed,
 472                        N_("show files on the filesystem that need to be removed")),
 473                OPT_BIT(0, "directory", &dir.flags,
 474                        N_("show 'other' directories' name only"),
 475                        DIR_SHOW_OTHER_DIRECTORIES),
 476                OPT_NEGBIT(0, "empty-directory", &dir.flags,
 477                        N_("don't show empty directories"),
 478                        DIR_HIDE_EMPTY_DIRECTORIES),
 479                OPT_BOOL('u', "unmerged", &show_unmerged,
 480                        N_("show unmerged files in the output")),
 481                OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
 482                            N_("show resolve-undo information")),
 483                { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
 484                        N_("skip files matching pattern"),
 485                        0, option_parse_exclude },
 486                { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
 487                        N_("exclude patterns are read from <file>"),
 488                        0, option_parse_exclude_from },
 489                OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
 490                        N_("read additional per-directory exclude patterns in <file>")),
 491                { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
 492                        N_("add the standard git exclusions"),
 493                        PARSE_OPT_NOARG, option_parse_exclude_standard },
 494                { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
 495                        N_("make the output relative to the project top directory"),
 496                        PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
 497                OPT_BOOL(0, "error-unmatch", &error_unmatch,
 498                        N_("if any <file> is not in the index, treat this as an error")),
 499                OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
 500                        N_("pretend that paths removed since <tree-ish> are still present")),
 501                OPT__ABBREV(&abbrev),
 502                OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
 503                OPT_END()
 504        };
 505
 506        if (argc == 2 && !strcmp(argv[1], "-h"))
 507                usage_with_options(ls_files_usage, builtin_ls_files_options);
 508
 509        memset(&dir, 0, sizeof(dir));
 510        prefix = cmd_prefix;
 511        if (prefix)
 512                prefix_len = strlen(prefix);
 513        git_config(git_default_config, NULL);
 514
 515        if (read_cache() < 0)
 516                die("index file corrupt");
 517
 518        argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
 519                        ls_files_usage, 0);
 520        el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
 521        for (i = 0; i < exclude_list.nr; i++) {
 522                add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
 523        }
 524        if (show_tag || show_valid_bit) {
 525                tag_cached = "H ";
 526                tag_unmerged = "M ";
 527                tag_removed = "R ";
 528                tag_modified = "C ";
 529                tag_other = "? ";
 530                tag_killed = "K ";
 531                tag_skip_worktree = "S ";
 532                tag_resolve_undo = "U ";
 533        }
 534        if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
 535                require_work_tree = 1;
 536        if (show_unmerged)
 537                /*
 538                 * There's no point in showing unmerged unless
 539                 * you also show the stage information.
 540                 */
 541                show_stage = 1;
 542        if (dir.exclude_per_dir)
 543                exc_given = 1;
 544
 545        if (require_work_tree && !is_inside_work_tree())
 546                setup_work_tree();
 547
 548        parse_pathspec(&pathspec, 0,
 549                       PATHSPEC_PREFER_CWD |
 550                       PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
 551                       prefix, argv);
 552
 553        /* Find common prefix for all pathspec's */
 554        max_prefix = common_prefix(&pathspec);
 555        max_prefix_len = max_prefix ? strlen(max_prefix) : 0;
 556
 557        /* Treat unmatching pathspec elements as errors */
 558        if (pathspec.nr && error_unmatch)
 559                ps_matched = xcalloc(1, pathspec.nr);
 560
 561        if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
 562                die("ls-files --ignored needs some exclude pattern");
 563
 564        /* With no flags, we default to showing the cached files */
 565        if (!(show_stage || show_deleted || show_others || show_unmerged ||
 566              show_killed || show_modified || show_resolve_undo))
 567                show_cached = 1;
 568
 569        if (max_prefix)
 570                prune_cache(max_prefix);
 571        if (with_tree) {
 572                /*
 573                 * Basic sanity check; show-stages and show-unmerged
 574                 * would not make any sense with this option.
 575                 */
 576                if (show_stage || show_unmerged)
 577                        die("ls-files --with-tree is incompatible with -s or -u");
 578                overlay_tree_on_cache(with_tree, max_prefix);
 579        }
 580        show_files(&dir);
 581        if (show_resolve_undo)
 582                show_ru_info();
 583
 584        if (ps_matched) {
 585                int bad;
 586                bad = report_path_error(ps_matched, &pathspec, prefix);
 587                if (bad)
 588                        fprintf(stderr, "Did you forget to 'git add'?\n");
 589
 590                return bad ? 1 : 0;
 591        }
 592
 593        return 0;
 594}