Merge branch 'am/ci-wsfix'
[git] / builtin / check-ignore.c
1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
2 #include "builtin.h"
3 #include "cache.h"
4 #include "config.h"
5 #include "dir.h"
6 #include "quote.h"
7 #include "pathspec.h"
8 #include "parse-options.h"
9 #include "submodule.h"
10
11 static int quiet, verbose, stdin_paths, show_non_matching, no_index;
12 static const char * const check_ignore_usage[] = {
13 "git check-ignore [<options>] <pathname>...",
14 "git check-ignore [<options>] --stdin",
15 NULL
16 };
17
18 static int nul_term_line;
19
20 static const struct option check_ignore_options[] = {
21         OPT__QUIET(&quiet, N_("suppress progress reporting")),
22         OPT__VERBOSE(&verbose, N_("be verbose")),
23         OPT_GROUP(""),
24         OPT_BOOL(0, "stdin", &stdin_paths,
25                  N_("read file names from stdin")),
26         OPT_BOOL('z', NULL, &nul_term_line,
27                  N_("terminate input and output records by a NUL character")),
28         OPT_BOOL('n', "non-matching", &show_non_matching,
29                  N_("show non-matching input paths")),
30         OPT_BOOL(0, "no-index", &no_index,
31                  N_("ignore index when checking")),
32         OPT_END()
33 };
34
35 static void output_pattern(const char *path, struct path_pattern *pattern)
36 {
37         char *bang  = (pattern && pattern->flags & PATTERN_FLAG_NEGATIVE)  ? "!" : "";
38         char *slash = (pattern && pattern->flags & PATTERN_FLAG_MUSTBEDIR) ? "/" : "";
39         if (!nul_term_line) {
40                 if (!verbose) {
41                         write_name_quoted(path, stdout, '\n');
42                 } else {
43                         if (pattern) {
44                                 quote_c_style(pattern->pl->src, NULL, stdout, 0);
45                                 printf(":%d:%s%s%s\t",
46                                        pattern->srcpos,
47                                        bang, pattern->pattern, slash);
48                         }
49                         else {
50                                 printf("::\t");
51                         }
52                         quote_c_style(path, NULL, stdout, 0);
53                         fputc('\n', stdout);
54                 }
55         } else {
56                 if (!verbose) {
57                         printf("%s%c", path, '\0');
58                 } else {
59                         if (pattern)
60                                 printf("%s%c%d%c%s%s%s%c%s%c",
61                                        pattern->pl->src, '\0',
62                                        pattern->srcpos, '\0',
63                                        bang, pattern->pattern, slash, '\0',
64                                        path, '\0');
65                         else
66                                 printf("%c%c%c%s%c", '\0', '\0', '\0', path, '\0');
67                 }
68         }
69 }
70
71 static int check_ignore(struct dir_struct *dir,
72                         const char *prefix, int argc, const char **argv)
73 {
74         const char *full_path;
75         char *seen;
76         int num_ignored = 0, i;
77         struct path_pattern *pattern;
78         struct pathspec pathspec;
79
80         if (!argc) {
81                 if (!quiet)
82                         fprintf(stderr, "no pathspec given.\n");
83                 return 0;
84         }
85
86         /*
87          * check-ignore just needs paths. Magic beyond :/ is really
88          * irrelevant.
89          */
90         parse_pathspec(&pathspec,
91                        PATHSPEC_ALL_MAGIC & ~PATHSPEC_FROMTOP,
92                        PATHSPEC_SYMLINK_LEADING_PATH |
93                        PATHSPEC_KEEP_ORDER,
94                        prefix, argv);
95
96         die_path_inside_submodule(&the_index, &pathspec);
97
98         /*
99          * look for pathspecs matching entries in the index, since these
100          * should not be ignored, in order to be consistent with
101          * 'git status', 'git add' etc.
102          */
103         seen = find_pathspecs_matching_against_index(&pathspec, &the_index);
104         for (i = 0; i < pathspec.nr; i++) {
105                 full_path = pathspec.items[i].match;
106                 pattern = NULL;
107                 if (!seen[i]) {
108                         int dtype = DT_UNKNOWN;
109                         pattern = last_matching_pattern(dir, &the_index,
110                                                         full_path, &dtype);
111                         if (!verbose && pattern &&
112                             pattern->flags & PATTERN_FLAG_NEGATIVE)
113                                 pattern = NULL;
114                 }
115                 if (!quiet && (pattern || show_non_matching))
116                         output_pattern(pathspec.items[i].original, pattern);
117                 if (pattern)
118                         num_ignored++;
119         }
120         free(seen);
121
122         return num_ignored;
123 }
124
125 static int check_ignore_stdin_paths(struct dir_struct *dir, const char *prefix)
126 {
127         struct strbuf buf = STRBUF_INIT;
128         struct strbuf unquoted = STRBUF_INIT;
129         char *pathspec[2] = { NULL, NULL };
130         strbuf_getline_fn getline_fn;
131         int num_ignored = 0;
132
133         getline_fn = nul_term_line ? strbuf_getline_nul : strbuf_getline_lf;
134         while (getline_fn(&buf, stdin) != EOF) {
135                 if (!nul_term_line && buf.buf[0] == '"') {
136                         strbuf_reset(&unquoted);
137                         if (unquote_c_style(&unquoted, buf.buf, NULL))
138                                 die("line is badly quoted");
139                         strbuf_swap(&buf, &unquoted);
140                 }
141                 pathspec[0] = buf.buf;
142                 num_ignored += check_ignore(dir, prefix,
143                                             1, (const char **)pathspec);
144                 maybe_flush_or_die(stdout, "check-ignore to stdout");
145         }
146         strbuf_release(&buf);
147         strbuf_release(&unquoted);
148         return num_ignored;
149 }
150
151 int cmd_check_ignore(int argc, const char **argv, const char *prefix)
152 {
153         int num_ignored;
154         struct dir_struct dir;
155
156         git_config(git_default_config, NULL);
157
158         argc = parse_options(argc, argv, prefix, check_ignore_options,
159                              check_ignore_usage, 0);
160
161         if (stdin_paths) {
162                 if (argc > 0)
163                         die(_("cannot specify pathnames with --stdin"));
164         } else {
165                 if (nul_term_line)
166                         die(_("-z only makes sense with --stdin"));
167                 if (argc == 0)
168                         die(_("no path specified"));
169         }
170         if (quiet) {
171                 if (argc > 1)
172                         die(_("--quiet is only valid with a single pathname"));
173                 if (verbose)
174                         die(_("cannot have both --quiet and --verbose"));
175         }
176         if (show_non_matching && !verbose)
177                 die(_("--non-matching is only valid with --verbose"));
178
179         /* read_cache() is only necessary so we can watch out for submodules. */
180         if (!no_index && read_cache() < 0)
181                 die(_("index file corrupt"));
182
183         dir_init(&dir);
184         setup_standard_excludes(&dir);
185
186         if (stdin_paths) {
187                 num_ignored = check_ignore_stdin_paths(&dir, prefix);
188         } else {
189                 num_ignored = check_ignore(&dir, prefix, argc, argv);
190                 maybe_flush_or_die(stdout, "ignore to stdout");
191         }
192
193         dir_clear(&dir);
194
195         return !num_ignored;
196 }