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