builtin/check-ignore.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "dir.h"
   4 #include "quote.h"
   5 #include "pathspec.h"
   6 #include "parse-options.h"
   7
   8 static int quiet, verbose, stdin_paths;
   9 static const char * const check_ignore_usage[] = {
  10 "git check-ignore [options] pathname...",
  11 "git check-ignore [options] --stdin < <list-of-paths>",
  12 NULL
  13 };
  14
  15 static int null_term_line;
  16
  17 static const struct option check_ignore_options[] = {
  18         OPT__QUIET(&quiet, N_("suppress progress reporting")),
  19         OPT__VERBOSE(&verbose, N_("be verbose")),
  20         OPT_GROUP(""),
  21         OPT_BOOLEAN(0, "stdin", &stdin_paths,
  22                     N_("read file names from stdin")),
  23         OPT_BOOLEAN('z', NULL, &null_term_line,
  24                     N_("input paths are terminated by a null character")),
  25         OPT_END()
  26 };
  27
  28 static void output_exclude(const char *path, struct exclude *exclude)
  29 {
  30         char *bang  = exclude->flags & EXC_FLAG_NEGATIVE  ? "!" : "";
  31         char *slash = exclude->flags & EXC_FLAG_MUSTBEDIR ? "/" : "";
  32         if (!null_term_line) {
  33                 if (!verbose) {
  34                         write_name_quoted(path, stdout, '\n');
  35                 } else {
  36                         quote_c_style(exclude->el->src, NULL, stdout, 0);
  37                         printf(":%d:%s%s%s\t",
  38                                exclude->srcpos,
  39                                bang, exclude->pattern, slash);
  40                         quote_c_style(path, NULL, stdout, 0);
  41                         fputc('\n', stdout);
  42                 }
  43         } else {
  44                 if (!verbose) {
  45                         printf("%s%c", path, '\0');
  46                 } else {
  47                         printf("%s%c%d%c%s%s%s%c%s%c",
  48                                exclude->el->src, '\0',
  49                                exclude->srcpos, '\0',
  50                                bang, exclude->pattern, slash, '\0',
  51                                path, '\0');
  52                 }
  53         }
  54 }
  55
  56 static int check_ignore(const char *prefix, const char **pathspec)
  57 {
  58         struct dir_struct dir;
  59         const char *path, *full_path;
  60         char *seen;
  61         int num_ignored = 0, dtype = DT_UNKNOWN, i;
  62         struct exclude *exclude;
  63
  64         /* read_cache() is only necessary so we can watch out for submodules. */
  65         if (read_cache() < 0)
  66                 die(_("index file corrupt"));
  67
  68         memset(&dir, 0, sizeof(dir));
  69         setup_standard_excludes(&dir);
  70
  71         if (!pathspec || !*pathspec) {
  72                 if (!quiet)
  73                         fprintf(stderr, "no pathspec given.\n");
  74                 return 0;
  75         }
  76
  77         /*
  78          * look for pathspecs matching entries in the index, since these
  79          * should not be ignored, in order to be consistent with
  80          * 'git status', 'git add' etc.
  81          */
  82         seen = find_pathspecs_matching_against_index(pathspec);
  83         for (i = 0; pathspec[i]; i++) {
  84                 path = pathspec[i];
  85                 full_path = prefix_path(prefix, prefix
  86                                         ? strlen(prefix) : 0, path);
  87                 full_path = check_path_for_gitlink(full_path);
  88                 die_if_path_beyond_symlink(full_path, prefix);
  89                 if (!seen[i]) {
  90                         exclude = last_exclude_matching(&dir, full_path, &dtype);
  91                         if (exclude) {
  92                                 if (!quiet)
  93                                         output_exclude(path, exclude);
  94                                 num_ignored++;
  95                         }
  96                 }
  97         }
  98         free(seen);
  99         clear_directory(&dir);
 100
 101         return num_ignored;
 102 }
 103
 104 static int check_ignore_stdin_paths(const char *prefix)
 105 {
 106         struct strbuf buf, nbuf;
 107         char **pathspec = NULL;
 108         size_t nr = 0, alloc = 0;
 109         int line_termination = null_term_line ? 0 : '\n';
 110         int num_ignored;
 111
 112         strbuf_init(&buf, 0);
 113         strbuf_init(&nbuf, 0);
 114         while (strbuf_getline(&buf, stdin, line_termination) != EOF) {
 115                 if (line_termination && buf.buf[0] == '"') {
 116                         strbuf_reset(&nbuf);
 117                         if (unquote_c_style(&nbuf, buf.buf, NULL))
 118                                 die("line is badly quoted");
 119                         strbuf_swap(&buf, &nbuf);
 120                 }
 121                 ALLOC_GROW(pathspec, nr + 1, alloc);
 122                 pathspec[nr] = xcalloc(strlen(buf.buf) + 1, sizeof(*buf.buf));
 123                 strcpy(pathspec[nr++], buf.buf);
 124         }
 125         ALLOC_GROW(pathspec, nr + 1, alloc);
 126         pathspec[nr] = NULL;
 127         num_ignored = check_ignore(prefix, (const char **)pathspec);
 128         maybe_flush_or_die(stdout, "attribute to stdout");
 129         strbuf_release(&buf);
 130         strbuf_release(&nbuf);
 131         free(pathspec);
 132         return num_ignored;
 133 }
 134
 135 int cmd_check_ignore(int argc, const char **argv, const char *prefix)
 136 {
 137         int num_ignored;
 138
 139         git_config(git_default_config, NULL);
 140
 141         argc = parse_options(argc, argv, prefix, check_ignore_options,
 142                              check_ignore_usage, 0);
 143
 144         if (stdin_paths) {
 145                 if (argc > 0)
 146                         die(_("cannot specify pathnames with --stdin"));
 147         } else {
 148                 if (null_term_line)
 149                         die(_("-z only makes sense with --stdin"));
 150                 if (argc == 0)
 151                         die(_("no path specified"));
 152         }
 153         if (quiet) {
 154                 if (argc > 1)
 155                         die(_("--quiet is only valid with a single pathname"));
 156                 if (verbose)
 157                         die(_("cannot have both --quiet and --verbose"));
 158         }
 159
 160         if (stdin_paths) {
 161                 num_ignored = check_ignore_stdin_paths(prefix);
 162         } else {
 163                 num_ignored = check_ignore(prefix, argv);
 164                 maybe_flush_or_die(stdout, "ignore to stdout");
 165         }
 166
 167         return !num_ignored;
 168 }