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