builtin / ls-tree.con commit Tests: clean up and document submodule helpers (d3b5a49)
   1/*
   2 * GIT - The information manager from hell
   3 *
   4 * Copyright (C) Linus Torvalds, 2005
   5 */
   6#include "cache.h"
   7#include "config.h"
   8#include "blob.h"
   9#include "tree.h"
  10#include "commit.h"
  11#include "quote.h"
  12#include "builtin.h"
  13#include "parse-options.h"
  14#include "pathspec.h"
  15
  16static int line_termination = '\n';
  17#define LS_RECURSIVE 1
  18#define LS_TREE_ONLY 2
  19#define LS_SHOW_TREES 4
  20#define LS_NAME_ONLY 8
  21#define LS_SHOW_SIZE 16
  22static int abbrev;
  23static int ls_options;
  24static struct pathspec pathspec;
  25static int chomp_prefix;
  26static const char *ls_tree_prefix;
  27
  28static const  char * const ls_tree_usage[] = {
  29        N_("git ls-tree [<options>] <tree-ish> [<path>...]"),
  30        NULL
  31};
  32
  33static int show_recursive(const char *base, int baselen, const char *pathname)
  34{
  35        int i;
  36
  37        if (ls_options & LS_RECURSIVE)
  38                return 1;
  39
  40        if (!pathspec.nr)
  41                return 0;
  42
  43        for (i = 0; i < pathspec.nr; i++) {
  44                const char *spec = pathspec.items[i].match;
  45                int len, speclen;
  46
  47                if (strncmp(base, spec, baselen))
  48                        continue;
  49                len = strlen(pathname);
  50                spec += baselen;
  51                speclen = strlen(spec);
  52                if (speclen <= len)
  53                        continue;
  54                if (spec[len] && spec[len] != '/')
  55                        continue;
  56                if (memcmp(pathname, spec, len))
  57                        continue;
  58                return 1;
  59        }
  60        return 0;
  61}
  62
  63static int show_tree(const unsigned char *sha1, struct strbuf *base,
  64                const char *pathname, unsigned mode, int stage, void *context)
  65{
  66        int retval = 0;
  67        int baselen;
  68        const char *type = blob_type;
  69
  70        if (S_ISGITLINK(mode)) {
  71                /*
  72                 * Maybe we want to have some recursive version here?
  73                 *
  74                 * Something similar to this incomplete example:
  75                 *
  76                if (show_subprojects(base, baselen, pathname))
  77                        retval = READ_TREE_RECURSIVE;
  78                 *
  79                 */
  80                type = commit_type;
  81        } else if (S_ISDIR(mode)) {
  82                if (show_recursive(base->buf, base->len, pathname)) {
  83                        retval = READ_TREE_RECURSIVE;
  84                        if (!(ls_options & LS_SHOW_TREES))
  85                                return retval;
  86                }
  87                type = tree_type;
  88        }
  89        else if (ls_options & LS_TREE_ONLY)
  90                return 0;
  91
  92        if (!(ls_options & LS_NAME_ONLY)) {
  93                if (ls_options & LS_SHOW_SIZE) {
  94                        char size_text[24];
  95                        if (!strcmp(type, blob_type)) {
  96                                unsigned long size;
  97                                if (sha1_object_info(sha1, &size) == OBJ_BAD)
  98                                        xsnprintf(size_text, sizeof(size_text),
  99                                                  "BAD");
 100                                else
 101                                        xsnprintf(size_text, sizeof(size_text),
 102                                                  "%lu", size);
 103                        } else
 104                                xsnprintf(size_text, sizeof(size_text), "-");
 105                        printf("%06o %s %s %7s\t", mode, type,
 106                               find_unique_abbrev(sha1, abbrev),
 107                               size_text);
 108                } else
 109                        printf("%06o %s %s\t", mode, type,
 110                               find_unique_abbrev(sha1, abbrev));
 111        }
 112        baselen = base->len;
 113        strbuf_addstr(base, pathname);
 114        write_name_quoted_relative(base->buf,
 115                                   chomp_prefix ? ls_tree_prefix : NULL,
 116                                   stdout, line_termination);
 117        strbuf_setlen(base, baselen);
 118        return retval;
 119}
 120
 121int cmd_ls_tree(int argc, const char **argv, const char *prefix)
 122{
 123        struct object_id oid;
 124        struct tree *tree;
 125        int i, full_tree = 0;
 126        const struct option ls_tree_options[] = {
 127                OPT_BIT('d', NULL, &ls_options, N_("only show trees"),
 128                        LS_TREE_ONLY),
 129                OPT_BIT('r', NULL, &ls_options, N_("recurse into subtrees"),
 130                        LS_RECURSIVE),
 131                OPT_BIT('t', NULL, &ls_options, N_("show trees when recursing"),
 132                        LS_SHOW_TREES),
 133                OPT_SET_INT('z', NULL, &line_termination,
 134                            N_("terminate entries with NUL byte"), 0),
 135                OPT_BIT('l', "long", &ls_options, N_("include object size"),
 136                        LS_SHOW_SIZE),
 137                OPT_BIT(0, "name-only", &ls_options, N_("list only filenames"),
 138                        LS_NAME_ONLY),
 139                OPT_BIT(0, "name-status", &ls_options, N_("list only filenames"),
 140                        LS_NAME_ONLY),
 141                OPT_SET_INT(0, "full-name", &chomp_prefix,
 142                            N_("use full path names"), 0),
 143                OPT_BOOL(0, "full-tree", &full_tree,
 144                         N_("list entire tree; not just current directory "
 145                            "(implies --full-name)")),
 146                OPT__ABBREV(&abbrev),
 147                OPT_END()
 148        };
 149
 150        git_config(git_default_config, NULL);
 151        ls_tree_prefix = prefix;
 152        if (prefix && *prefix)
 153                chomp_prefix = strlen(prefix);
 154
 155        argc = parse_options(argc, argv, prefix, ls_tree_options,
 156                             ls_tree_usage, 0);
 157        if (full_tree) {
 158                ls_tree_prefix = prefix = NULL;
 159                chomp_prefix = 0;
 160        }
 161        /* -d -r should imply -t, but -d by itself should not have to. */
 162        if ( (LS_TREE_ONLY|LS_RECURSIVE) ==
 163            ((LS_TREE_ONLY|LS_RECURSIVE) & ls_options))
 164                ls_options |= LS_SHOW_TREES;
 165
 166        if (argc < 1)
 167                usage_with_options(ls_tree_usage, ls_tree_options);
 168        if (get_oid(argv[0], &oid))
 169                die("Not a valid object name %s", argv[0]);
 170
 171        /*
 172         * show_recursive() rolls its own matching code and is
 173         * generally ignorant of 'struct pathspec'. The magic mask
 174         * cannot be lifted until it is converted to use
 175         * match_pathspec() or tree_entry_interesting()
 176         */
 177        parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC &
 178                                  ~(PATHSPEC_FROMTOP | PATHSPEC_LITERAL),
 179                       PATHSPEC_PREFER_CWD,
 180                       prefix, argv + 1);
 181        for (i = 0; i < pathspec.nr; i++)
 182                pathspec.items[i].nowildcard_len = pathspec.items[i].len;
 183        pathspec.has_wildcard = 0;
 184        tree = parse_tree_indirect(&oid);
 185        if (!tree)
 186                die("not a tree object");
 187        return !!read_tree_recursive(tree, "", 0, 0, &pathspec, show_tree, NULL);
 188}