6 * Finds which of the given pathspecs match items in the index.
8 * For each pathspec, sets the corresponding entry in the seen[] array
9 * (which should be specs items long, i.e. the same size as pathspec)
10 * to the nature of the "closest" (i.e. most specific) match found for
11 * that pathspec in the index, if it was a closer type of match than
12 * the existing entry. As an optimization, matching is skipped
13 * altogether if seen[] already only contains non-zero entries.
15 * If seen[] has not already been written to, it may make sense
16 * to use find_pathspecs_matching_against_index() instead.
18 void add_pathspec_matches_against_index(const struct pathspec
*pathspec
,
21 int num_unmatched
= 0, i
;
24 * Since we are walking the index as if we were walking the directory,
25 * we have to mark the matched pathspec as seen; otherwise we will
26 * mistakenly think that the user gave a pathspec that did not match
29 for (i
= 0; i
< pathspec
->nr
; i
++)
34 for (i
= 0; i
< active_nr
; i
++) {
35 const struct cache_entry
*ce
= active_cache
[i
];
36 ce_path_match(ce
, pathspec
, seen
);
41 * Finds which of the given pathspecs match items in the index.
43 * This is a one-shot wrapper around add_pathspec_matches_against_index()
44 * which allocates, populates, and returns a seen[] array indicating the
45 * nature of the "closest" (i.e. most specific) matches which each of the
46 * given pathspecs achieves against all items in the index.
48 char *find_pathspecs_matching_against_index(const struct pathspec
*pathspec
)
50 char *seen
= xcalloc(pathspec
->nr
, 1);
51 add_pathspec_matches_against_index(pathspec
, seen
);
58 * Possible future magic semantics include stuff like:
60 * { PATHSPEC_RECURSIVE, '*', "recursive" },
61 * { PATHSPEC_REGEXP, '\0', "regexp" },
65 static struct pathspec_magic
{
67 char mnemonic
; /* this cannot be ':'! */
69 } pathspec_magic
[] = {
70 { PATHSPEC_FROMTOP
, '/', "top" },
71 { PATHSPEC_LITERAL
, 0, "literal" },
72 { PATHSPEC_GLOB
, '\0', "glob" },
73 { PATHSPEC_ICASE
, '\0', "icase" },
74 { PATHSPEC_EXCLUDE
, '!', "exclude" },
77 static void prefix_magic(struct strbuf
*sb
, int prefixlen
, unsigned magic
)
80 strbuf_addstr(sb
, ":(");
81 for (i
= 0; i
< ARRAY_SIZE(pathspec_magic
); i
++)
82 if (magic
& pathspec_magic
[i
].bit
) {
83 if (sb
->buf
[sb
->len
- 1] != '(')
84 strbuf_addch(sb
, ',');
85 strbuf_addstr(sb
, pathspec_magic
[i
].name
);
87 strbuf_addf(sb
, ",prefix:%d)", prefixlen
);
90 static inline int get_literal_global(void)
92 static int literal
= -1;
95 literal
= git_env_bool(GIT_LITERAL_PATHSPECS_ENVIRONMENT
, 0);
100 static inline int get_glob_global(void)
102 static int glob
= -1;
105 glob
= git_env_bool(GIT_GLOB_PATHSPECS_ENVIRONMENT
, 0);
110 static inline int get_noglob_global(void)
112 static int noglob
= -1;
115 noglob
= git_env_bool(GIT_NOGLOB_PATHSPECS_ENVIRONMENT
, 0);
120 static inline int get_icase_global(void)
122 static int icase
= -1;
125 icase
= git_env_bool(GIT_ICASE_PATHSPECS_ENVIRONMENT
, 0);
130 static int get_global_magic(int element_magic
)
132 int global_magic
= 0;
134 if (get_literal_global())
135 global_magic
|= PATHSPEC_LITERAL
;
137 /* --glob-pathspec is overridden by :(literal) */
138 if (get_glob_global() && !(element_magic
& PATHSPEC_LITERAL
))
139 global_magic
|= PATHSPEC_GLOB
;
141 if (get_glob_global() && get_noglob_global())
142 die(_("global 'glob' and 'noglob' pathspec settings are incompatible"));
144 if (get_icase_global())
145 global_magic
|= PATHSPEC_ICASE
;
147 if ((global_magic
& PATHSPEC_LITERAL
) &&
148 (global_magic
& ~PATHSPEC_LITERAL
))
149 die(_("global 'literal' pathspec setting is incompatible "
150 "with all other global pathspec settings"));
152 /* --noglob-pathspec adds :(literal) _unless_ :(glob) is specified */
153 if (get_noglob_global() && !(element_magic
& PATHSPEC_GLOB
))
154 global_magic
|= PATHSPEC_LITERAL
;
160 * Parse the pathspec element looking for long magic
162 * saves all magic in 'magic'
163 * if prefix magic is used, save the prefix length in 'prefix_len'
164 * returns the position in 'elem' after all magic has been parsed
166 static const char *parse_long_magic(unsigned *magic
, int *prefix_len
,
172 for (pos
= elem
+ 2; *pos
&& *pos
!= ')'; pos
= nextat
) {
173 size_t len
= strcspn(pos
, ",)");
177 nextat
= pos
+ len
+ 1; /* handle ',' */
179 nextat
= pos
+ len
; /* handle ')' and '\0' */
184 if (starts_with(pos
, "prefix:")) {
186 *prefix_len
= strtol(pos
+ 7, &endptr
, 10);
187 if (endptr
- pos
!= len
)
188 die(_("invalid parameter for pathspec magic 'prefix'"));
192 for (i
= 0; i
< ARRAY_SIZE(pathspec_magic
); i
++) {
193 if (strlen(pathspec_magic
[i
].name
) == len
&&
194 !strncmp(pathspec_magic
[i
].name
, pos
, len
)) {
195 *magic
|= pathspec_magic
[i
].bit
;
200 if (ARRAY_SIZE(pathspec_magic
) <= i
)
201 die(_("Invalid pathspec magic '%.*s' in '%s'"),
202 (int) len
, pos
, elem
);
206 die(_("Missing ')' at the end of pathspec magic in '%s'"),
214 * Parse the pathspec element looking for short magic
216 * saves all magic in 'magic'
217 * returns the position in 'elem' after all magic has been parsed
219 static const char *parse_short_magic(unsigned *magic
, const char *elem
)
223 for (pos
= elem
+ 1; *pos
&& *pos
!= ':'; pos
++) {
227 if (!is_pathspec_magic(ch
))
230 for (i
= 0; i
< ARRAY_SIZE(pathspec_magic
); i
++) {
231 if (pathspec_magic
[i
].mnemonic
== ch
) {
232 *magic
|= pathspec_magic
[i
].bit
;
237 if (ARRAY_SIZE(pathspec_magic
) <= i
)
238 die(_("Unimplemented pathspec magic '%c' in '%s'"),
249 * Take an element of a pathspec and check for magic signatures.
250 * Append the result to the prefix. Return the magic bitmap.
252 * For now, we only parse the syntax and throw out anything other than
255 * NEEDSWORK: This needs to be rewritten when we start migrating
256 * get_pathspec() users to use the "struct pathspec" interface. For
257 * example, a pathspec element may be marked as case-insensitive, but
258 * the prefix part must always match literally, and a single stupid
259 * string cannot express such a case.
261 static unsigned prefix_pathspec(struct pathspec_item
*item
, unsigned flags
,
262 const char *prefix
, int prefixlen
,
265 unsigned magic
= 0, element_magic
= 0;
266 const char *copyfrom
= elt
;
268 int i
, pathspec_prefix
= -1;
270 if (elt
[0] != ':' || get_literal_global() ||
271 (flags
& PATHSPEC_LITERAL_PATH
)) {
272 ; /* nothing to do */
273 } else if (elt
[1] == '(') {
275 copyfrom
= parse_long_magic(&element_magic
,
280 copyfrom
= parse_short_magic(&element_magic
, elt
);
283 magic
|= element_magic
;
285 /* PATHSPEC_LITERAL_PATH ignores magic */
286 if (flags
& PATHSPEC_LITERAL_PATH
)
287 magic
= PATHSPEC_LITERAL
;
289 magic
|= get_global_magic(element_magic
);
291 if (pathspec_prefix
>= 0 &&
292 (prefixlen
|| (prefix
&& *prefix
)))
293 die("BUG: 'prefix' magic is supposed to be used at worktree's root");
295 if ((magic
& PATHSPEC_LITERAL
) && (magic
& PATHSPEC_GLOB
))
296 die(_("%s: 'literal' and 'glob' are incompatible"), elt
);
298 if (pathspec_prefix
>= 0) {
299 match
= xstrdup(copyfrom
);
300 prefixlen
= pathspec_prefix
;
301 } else if (magic
& PATHSPEC_FROMTOP
) {
302 match
= xstrdup(copyfrom
);
305 match
= prefix_path_gently(prefix
, prefixlen
, &prefixlen
, copyfrom
);
307 die(_("%s: '%s' is outside repository"), elt
, copyfrom
);
311 * Prefix the pathspec (keep all magic) and assign to
312 * original. Useful for passing to another command.
314 if ((flags
& PATHSPEC_PREFIX_ORIGIN
) &&
315 prefixlen
&& !get_literal_global()) {
316 struct strbuf sb
= STRBUF_INIT
;
318 /* Preserve the actual prefix length of each pattern */
319 prefix_magic(&sb
, prefixlen
, element_magic
);
321 strbuf_addstr(&sb
, match
);
322 item
->original
= strbuf_detach(&sb
, NULL
);
324 item
->original
= xstrdup(elt
);
326 item
->len
= strlen(item
->match
);
327 item
->prefix
= prefixlen
;
329 if ((flags
& PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP
) &&
330 (item
->len
>= 1 && item
->match
[item
->len
- 1] == '/') &&
331 (i
= cache_name_pos(item
->match
, item
->len
- 1)) >= 0 &&
332 S_ISGITLINK(active_cache
[i
]->ce_mode
)) {
334 match
[item
->len
] = '\0';
337 if (flags
& PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE
)
338 for (i
= 0; i
< active_nr
; i
++) {
339 struct cache_entry
*ce
= active_cache
[i
];
340 int ce_len
= ce_namelen(ce
);
342 if (!S_ISGITLINK(ce
->ce_mode
))
345 if (item
->len
<= ce_len
|| match
[ce_len
] != '/' ||
346 memcmp(ce
->name
, match
, ce_len
))
348 if (item
->len
== ce_len
+ 1) {
349 /* strip trailing slash */
351 match
[item
->len
] = '\0';
353 die (_("Pathspec '%s' is in submodule '%.*s'"),
354 elt
, ce_len
, ce
->name
);
357 if (magic
& PATHSPEC_LITERAL
)
358 item
->nowildcard_len
= item
->len
;
360 item
->nowildcard_len
= simple_length(item
->match
);
361 if (item
->nowildcard_len
< prefixlen
)
362 item
->nowildcard_len
= prefixlen
;
365 if (magic
& PATHSPEC_GLOB
) {
367 * FIXME: should we enable ONESTAR in _GLOB for
368 * pattern "* * / * . c"?
371 if (item
->nowildcard_len
< item
->len
&&
372 item
->match
[item
->nowildcard_len
] == '*' &&
373 no_wildcard(item
->match
+ item
->nowildcard_len
+ 1))
374 item
->flags
|= PATHSPEC_ONESTAR
;
377 /* sanity checks, pathspec matchers assume these are sane */
378 assert(item
->nowildcard_len
<= item
->len
&&
379 item
->prefix
<= item
->len
);
383 static int pathspec_item_cmp(const void *a_
, const void *b_
)
385 struct pathspec_item
*a
, *b
;
387 a
= (struct pathspec_item
*)a_
;
388 b
= (struct pathspec_item
*)b_
;
389 return strcmp(a
->match
, b
->match
);
392 static void NORETURN
unsupported_magic(const char *pattern
,
395 struct strbuf sb
= STRBUF_INIT
;
397 for (i
= 0; i
< ARRAY_SIZE(pathspec_magic
); i
++) {
398 const struct pathspec_magic
*m
= pathspec_magic
+ i
;
399 if (!(magic
& m
->bit
))
402 strbuf_addstr(&sb
, ", ");
405 strbuf_addf(&sb
, _("'%s' (mnemonic: '%c')"),
406 m
->name
, m
->mnemonic
);
408 strbuf_addf(&sb
, "'%s'", m
->name
);
411 * We may want to substitute "this command" with a command
412 * name. E.g. when add--interactive dies when running
415 die(_("%s: pathspec magic not supported by this command: %s"),
420 * Given command line arguments and a prefix, convert the input to
421 * pathspec. die() if any magic in magic_mask is used.
423 void parse_pathspec(struct pathspec
*pathspec
,
424 unsigned magic_mask
, unsigned flags
,
425 const char *prefix
, const char **argv
)
427 struct pathspec_item
*item
;
428 const char *entry
= argv
? *argv
: NULL
;
429 int i
, n
, prefixlen
, warn_empty_string
, nr_exclude
= 0;
431 memset(pathspec
, 0, sizeof(*pathspec
));
433 if (flags
& PATHSPEC_MAXDEPTH_VALID
)
434 pathspec
->magic
|= PATHSPEC_MAXDEPTH
;
436 /* No arguments, no prefix -> no pathspec */
437 if (!entry
&& !prefix
)
440 if ((flags
& PATHSPEC_PREFER_CWD
) &&
441 (flags
& PATHSPEC_PREFER_FULL
))
442 die("BUG: PATHSPEC_PREFER_CWD and PATHSPEC_PREFER_FULL are incompatible");
444 /* No arguments with prefix -> prefix pathspec */
446 if (flags
& PATHSPEC_PREFER_FULL
)
449 if (!(flags
& PATHSPEC_PREFER_CWD
))
450 die("BUG: PATHSPEC_PREFER_CWD requires arguments");
452 pathspec
->items
= item
= xcalloc(1, sizeof(*item
));
453 item
->match
= xstrdup(prefix
);
454 item
->original
= xstrdup(prefix
);
455 item
->nowildcard_len
= item
->len
= strlen(prefix
);
456 item
->prefix
= item
->len
;
462 warn_empty_string
= 1;
464 if (*argv
[n
] == '\0' && warn_empty_string
) {
465 warning(_("empty strings as pathspecs will be made invalid in upcoming releases. "
466 "please use . instead if you meant to match all paths"));
467 warn_empty_string
= 0;
473 ALLOC_ARRAY(pathspec
->items
, n
);
474 item
= pathspec
->items
;
475 prefixlen
= prefix
? strlen(prefix
) : 0;
477 for (i
= 0; i
< n
; i
++) {
480 item
[i
].magic
= prefix_pathspec(item
+ i
, flags
,
481 prefix
, prefixlen
, entry
);
483 if (item
[i
].magic
& PATHSPEC_EXCLUDE
)
485 if (item
[i
].magic
& magic_mask
)
486 unsupported_magic(entry
, item
[i
].magic
& magic_mask
);
488 if ((flags
& PATHSPEC_SYMLINK_LEADING_PATH
) &&
489 has_symlink_leading_path(item
[i
].match
, item
[i
].len
)) {
490 die(_("pathspec '%s' is beyond a symbolic link"), entry
);
493 if (item
[i
].nowildcard_len
< item
[i
].len
)
494 pathspec
->has_wildcard
= 1;
495 pathspec
->magic
|= item
[i
].magic
;
499 die(_("There is nothing to exclude from by :(exclude) patterns.\n"
500 "Perhaps you forgot to add either ':/' or '.' ?"));
503 if (pathspec
->magic
& PATHSPEC_MAXDEPTH
) {
504 if (flags
& PATHSPEC_KEEP_ORDER
)
505 die("BUG: PATHSPEC_MAXDEPTH_VALID and PATHSPEC_KEEP_ORDER are incompatible");
506 QSORT(pathspec
->items
, pathspec
->nr
, pathspec_item_cmp
);
510 void copy_pathspec(struct pathspec
*dst
, const struct pathspec
*src
)
515 ALLOC_ARRAY(dst
->items
, dst
->nr
);
516 COPY_ARRAY(dst
->items
, src
->items
, dst
->nr
);
518 for (i
= 0; i
< dst
->nr
; i
++) {
519 dst
->items
[i
].match
= xstrdup(src
->items
[i
].match
);
520 dst
->items
[i
].original
= xstrdup(src
->items
[i
].original
);
524 void clear_pathspec(struct pathspec
*pathspec
)
528 for (i
= 0; i
< pathspec
->nr
; i
++) {
529 free(pathspec
->items
[i
].match
);
530 free(pathspec
->items
[i
].original
);
532 free(pathspec
->items
);
533 pathspec
->items
= NULL
;