msysGit-based Git for Windows 1.x was superseded by Git for Windows 2.x
[git/mingw/4msysgit.git] / builtin / check-ignore.c
blob594463a11bcba3cf99748ccdaeb055bd79283ddd
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"
8 static int quiet, verbose, stdin_paths, show_non_matching, no_index;
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
15 static int nul_term_line;
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_BOOL(0, "stdin", &stdin_paths,
22 N_("read file names from stdin")),
23 OPT_BOOL('z', NULL, &nul_term_line,
24 N_("terminate input and output records by a NUL character")),
25 OPT_BOOL('n', "non-matching", &show_non_matching,
26 N_("show non-matching input paths")),
27 OPT_BOOL(0, "no-index", &no_index,
28 N_("ignore index when checking")),
29 OPT_END()
32 static void output_exclude(const char *path, struct exclude *exclude)
34 char *bang = (exclude && exclude->flags & EXC_FLAG_NEGATIVE) ? "!" : "";
35 char *slash = (exclude && exclude->flags & EXC_FLAG_MUSTBEDIR) ? "/" : "";
36 if (!nul_term_line) {
37 if (!verbose) {
38 write_name_quoted(path, stdout, '\n');
39 } else {
40 if (exclude) {
41 quote_c_style(exclude->el->src, NULL, stdout, 0);
42 printf(":%d:%s%s%s\t",
43 exclude->srcpos,
44 bang, exclude->pattern, slash);
46 else {
47 printf("::\t");
49 quote_c_style(path, NULL, stdout, 0);
50 fputc('\n', stdout);
52 } else {
53 if (!verbose) {
54 printf("%s%c", path, '\0');
55 } else {
56 if (exclude)
57 printf("%s%c%d%c%s%s%s%c%s%c",
58 exclude->el->src, '\0',
59 exclude->srcpos, '\0',
60 bang, exclude->pattern, slash, '\0',
61 path, '\0');
62 else
63 printf("%c%c%c%s%c", '\0', '\0', '\0', path, '\0');
68 static int check_ignore(struct dir_struct *dir,
69 const char *prefix, int argc, const char **argv)
71 const char *full_path;
72 char *seen;
73 int num_ignored = 0, dtype = DT_UNKNOWN, i;
74 struct exclude *exclude;
75 struct pathspec pathspec;
77 if (!argc) {
78 if (!quiet)
79 fprintf(stderr, "no pathspec given.\n");
80 return 0;
84 * check-ignore just needs paths. Magic beyond :/ is really
85 * irrelevant.
87 parse_pathspec(&pathspec,
88 PATHSPEC_ALL_MAGIC & ~PATHSPEC_FROMTOP,
89 PATHSPEC_SYMLINK_LEADING_PATH |
90 PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE |
91 PATHSPEC_KEEP_ORDER,
92 prefix, argv);
95 * look for pathspecs matching entries in the index, since these
96 * should not be ignored, in order to be consistent with
97 * 'git status', 'git add' etc.
99 seen = find_pathspecs_matching_against_index(&pathspec);
100 for (i = 0; i < pathspec.nr; i++) {
101 full_path = pathspec.items[i].match;
102 exclude = NULL;
103 if (!seen[i]) {
104 exclude = last_exclude_matching(dir, full_path, &dtype);
106 if (!quiet && (exclude || show_non_matching))
107 output_exclude(pathspec.items[i].original, exclude);
108 if (exclude)
109 num_ignored++;
111 free(seen);
113 return num_ignored;
116 static int check_ignore_stdin_paths(struct dir_struct *dir, const char *prefix)
118 struct strbuf buf, nbuf;
119 char *pathspec[2] = { NULL, NULL };
120 int line_termination = nul_term_line ? 0 : '\n';
121 int num_ignored = 0;
123 strbuf_init(&buf, 0);
124 strbuf_init(&nbuf, 0);
125 while (strbuf_getline(&buf, stdin, line_termination) != EOF) {
126 if (line_termination && buf.buf[0] == '"') {
127 strbuf_reset(&nbuf);
128 if (unquote_c_style(&nbuf, buf.buf, NULL))
129 die("line is badly quoted");
130 strbuf_swap(&buf, &nbuf);
132 pathspec[0] = buf.buf;
133 num_ignored += check_ignore(dir, prefix,
134 1, (const char **)pathspec);
135 maybe_flush_or_die(stdout, "check-ignore to stdout");
137 strbuf_release(&buf);
138 strbuf_release(&nbuf);
139 return num_ignored;
142 int cmd_check_ignore(int argc, const char **argv, const char *prefix)
144 int num_ignored;
145 struct dir_struct dir;
147 git_config(git_default_config, NULL);
149 argc = parse_options(argc, argv, prefix, check_ignore_options,
150 check_ignore_usage, 0);
152 if (stdin_paths) {
153 if (argc > 0)
154 die(_("cannot specify pathnames with --stdin"));
155 } else {
156 if (nul_term_line)
157 die(_("-z only makes sense with --stdin"));
158 if (argc == 0)
159 die(_("no path specified"));
161 if (quiet) {
162 if (argc > 1)
163 die(_("--quiet is only valid with a single pathname"));
164 if (verbose)
165 die(_("cannot have both --quiet and --verbose"));
167 if (show_non_matching && !verbose)
168 die(_("--non-matching is only valid with --verbose"));
170 /* read_cache() is only necessary so we can watch out for submodules. */
171 if (!no_index && read_cache() < 0)
172 die(_("index file corrupt"));
174 memset(&dir, 0, sizeof(dir));
175 setup_standard_excludes(&dir);
177 if (stdin_paths) {
178 num_ignored = check_ignore_stdin_paths(&dir, prefix);
179 } else {
180 num_ignored = check_ignore(&dir, prefix, argc, argv);
181 maybe_flush_or_die(stdout, "ignore to stdout");
184 clear_directory(&dir);
186 return !num_ignored;