7 * Finds which of the given pathspecs match items in the index.
9 * For each pathspec, sets the corresponding entry in the seen[] array
10 * (which should be specs items long, i.e. the same size as pathspec)
11 * to the nature of the "closest" (i.e. most specific) match found for
12 * that pathspec in the index, if it was a closer type of match than
13 * the existing entry. As an optimization, matching is skipped
14 * altogether if seen[] already only contains non-zero entries.
16 * If seen[] has not already been written to, it may make sense
17 * to use find_pathspecs_matching_against_index() instead.
19 void add_pathspec_matches_against_index(const struct pathspec
*pathspec
,
22 int num_unmatched
= 0, i
;
25 * Since we are walking the index as if we were walking the directory,
26 * we have to mark the matched pathspec as seen; otherwise we will
27 * mistakenly think that the user gave a pathspec that did not match
30 for (i
= 0; i
< pathspec
->nr
; i
++)
35 for (i
= 0; i
< active_nr
; i
++) {
36 const struct cache_entry
*ce
= active_cache
[i
];
37 ce_path_match(ce
, pathspec
, seen
);
42 * Finds which of the given pathspecs match items in the index.
44 * This is a one-shot wrapper around add_pathspec_matches_against_index()
45 * which allocates, populates, and returns a seen[] array indicating the
46 * nature of the "closest" (i.e. most specific) matches which each of the
47 * given pathspecs achieves against all items in the index.
49 char *find_pathspecs_matching_against_index(const struct pathspec
*pathspec
)
51 char *seen
= xcalloc(pathspec
->nr
, 1);
52 add_pathspec_matches_against_index(pathspec
, seen
);
59 * Possible future magic semantics include stuff like:
61 * { PATHSPEC_RECURSIVE, '*', "recursive" },
62 * { PATHSPEC_REGEXP, '\0', "regexp" },
66 static struct pathspec_magic
{
68 char mnemonic
; /* this cannot be ':'! */
70 } pathspec_magic
[] = {
71 { PATHSPEC_FROMTOP
, '/', "top" },
72 { PATHSPEC_LITERAL
, '\0', "literal" },
73 { PATHSPEC_GLOB
, '\0', "glob" },
74 { PATHSPEC_ICASE
, '\0', "icase" },
75 { PATHSPEC_EXCLUDE
, '!', "exclude" },
76 { PATHSPEC_ATTR
, '\0', "attr" },
79 static void prefix_magic(struct strbuf
*sb
, int prefixlen
, unsigned magic
)
82 strbuf_addstr(sb
, ":(");
83 for (i
= 0; i
< ARRAY_SIZE(pathspec_magic
); i
++)
84 if (magic
& pathspec_magic
[i
].bit
) {
85 if (sb
->buf
[sb
->len
- 1] != '(')
86 strbuf_addch(sb
, ',');
87 strbuf_addstr(sb
, pathspec_magic
[i
].name
);
89 strbuf_addf(sb
, ",prefix:%d)", prefixlen
);
92 static void parse_pathspec_attr_match(struct pathspec_item
*item
, const char *value
)
94 struct string_list_item
*si
;
95 struct string_list list
= STRING_LIST_INIT_DUP
;
97 if (item
->attr_check
|| item
->attr_match
)
98 die(_("Only one 'attr:' specification is allowed."));
100 if (!value
|| !*value
)
101 die(_("attr spec must not be empty"));
103 string_list_split(&list
, value
, ' ', -1);
104 string_list_remove_empty_items(&list
, 0);
106 item
->attr_check
= attr_check_alloc();
107 item
->attr_match
= xcalloc(list
.nr
, sizeof(struct attr_match
));
109 for_each_string_list_item(si
, &list
) {
112 const struct git_attr
*a
;
114 int j
= item
->attr_match_nr
++;
115 const char *attr
= si
->string
;
116 struct attr_match
*am
= &item
->attr_match
[j
];
120 am
->match_mode
= MATCH_UNSPECIFIED
;
122 attr_len
= strlen(attr
);
125 am
->match_mode
= MATCH_UNSET
;
127 attr_len
= strlen(attr
);
130 attr_len
= strcspn(attr
, "=");
131 if (attr
[attr_len
] != '=')
132 am
->match_mode
= MATCH_SET
;
134 am
->match_mode
= MATCH_VALUE
;
135 am
->value
= xstrdup(&attr
[attr_len
+ 1]);
136 if (strchr(am
->value
, '\\'))
137 die(_("attr spec values must not contain backslashes"));
142 attr_name
= xmemdupz(attr
, attr_len
);
143 a
= git_attr(attr_name
);
145 die(_("invalid attribute name %s"), attr_name
);
147 attr_check_append(item
->attr_check
, a
);
152 if (item
->attr_check
->nr
!= item
->attr_match_nr
)
153 die("BUG: should have same number of entries");
155 string_list_clear(&list
, 0);
158 static inline int get_literal_global(void)
160 static int literal
= -1;
163 literal
= git_env_bool(GIT_LITERAL_PATHSPECS_ENVIRONMENT
, 0);
168 static inline int get_glob_global(void)
170 static int glob
= -1;
173 glob
= git_env_bool(GIT_GLOB_PATHSPECS_ENVIRONMENT
, 0);
178 static inline int get_noglob_global(void)
180 static int noglob
= -1;
183 noglob
= git_env_bool(GIT_NOGLOB_PATHSPECS_ENVIRONMENT
, 0);
188 static inline int get_icase_global(void)
190 static int icase
= -1;
193 icase
= git_env_bool(GIT_ICASE_PATHSPECS_ENVIRONMENT
, 0);
198 static int get_global_magic(int element_magic
)
200 int global_magic
= 0;
202 if (get_literal_global())
203 global_magic
|= PATHSPEC_LITERAL
;
205 /* --glob-pathspec is overridden by :(literal) */
206 if (get_glob_global() && !(element_magic
& PATHSPEC_LITERAL
))
207 global_magic
|= PATHSPEC_GLOB
;
209 if (get_glob_global() && get_noglob_global())
210 die(_("global 'glob' and 'noglob' pathspec settings are incompatible"));
212 if (get_icase_global())
213 global_magic
|= PATHSPEC_ICASE
;
215 if ((global_magic
& PATHSPEC_LITERAL
) &&
216 (global_magic
& ~PATHSPEC_LITERAL
))
217 die(_("global 'literal' pathspec setting is incompatible "
218 "with all other global pathspec settings"));
220 /* --noglob-pathspec adds :(literal) _unless_ :(glob) is specified */
221 if (get_noglob_global() && !(element_magic
& PATHSPEC_GLOB
))
222 global_magic
|= PATHSPEC_LITERAL
;
228 * Parse the pathspec element looking for long magic
230 * saves all magic in 'magic'
231 * if prefix magic is used, save the prefix length in 'prefix_len'
232 * returns the position in 'elem' after all magic has been parsed
234 static const char *parse_long_magic(unsigned *magic
, int *prefix_len
,
235 struct pathspec_item
*item
,
241 for (pos
= elem
+ 2; *pos
&& *pos
!= ')'; pos
= nextat
) {
242 size_t len
= strcspn(pos
, ",)");
246 nextat
= pos
+ len
+ 1; /* handle ',' */
248 nextat
= pos
+ len
; /* handle ')' and '\0' */
253 if (starts_with(pos
, "prefix:")) {
255 *prefix_len
= strtol(pos
+ 7, &endptr
, 10);
256 if (endptr
- pos
!= len
)
257 die(_("invalid parameter for pathspec magic 'prefix'"));
261 if (starts_with(pos
, "attr:")) {
262 char *attr_body
= xmemdupz(pos
+ 5, len
- 5);
263 parse_pathspec_attr_match(item
, attr_body
);
264 *magic
|= PATHSPEC_ATTR
;
269 for (i
= 0; i
< ARRAY_SIZE(pathspec_magic
); i
++) {
270 if (strlen(pathspec_magic
[i
].name
) == len
&&
271 !strncmp(pathspec_magic
[i
].name
, pos
, len
)) {
272 *magic
|= pathspec_magic
[i
].bit
;
277 if (ARRAY_SIZE(pathspec_magic
) <= i
)
278 die(_("Invalid pathspec magic '%.*s' in '%s'"),
279 (int) len
, pos
, elem
);
283 die(_("Missing ')' at the end of pathspec magic in '%s'"),
291 * Parse the pathspec element looking for short magic
293 * saves all magic in 'magic'
294 * returns the position in 'elem' after all magic has been parsed
296 static const char *parse_short_magic(unsigned *magic
, const char *elem
)
300 for (pos
= elem
+ 1; *pos
&& *pos
!= ':'; pos
++) {
304 /* Special case alias for '!' */
306 *magic
|= PATHSPEC_EXCLUDE
;
310 if (!is_pathspec_magic(ch
))
313 for (i
= 0; i
< ARRAY_SIZE(pathspec_magic
); i
++) {
314 if (pathspec_magic
[i
].mnemonic
== ch
) {
315 *magic
|= pathspec_magic
[i
].bit
;
320 if (ARRAY_SIZE(pathspec_magic
) <= i
)
321 die(_("Unimplemented pathspec magic '%c' in '%s'"),
331 static const char *parse_element_magic(unsigned *magic
, int *prefix_len
,
332 struct pathspec_item
*item
,
335 if (elem
[0] != ':' || get_literal_global())
336 return elem
; /* nothing to do */
337 else if (elem
[1] == '(')
339 return parse_long_magic(magic
, prefix_len
, item
, elem
);
342 return parse_short_magic(magic
, elem
);
345 static void strip_submodule_slash_cheap(struct pathspec_item
*item
)
347 if (item
->len
>= 1 && item
->match
[item
->len
- 1] == '/') {
348 int i
= cache_name_pos(item
->match
, item
->len
- 1);
350 if (i
>= 0 && S_ISGITLINK(active_cache
[i
]->ce_mode
)) {
352 item
->match
[item
->len
] = '\0';
357 static void strip_submodule_slash_expensive(struct pathspec_item
*item
)
361 for (i
= 0; i
< active_nr
; i
++) {
362 struct cache_entry
*ce
= active_cache
[i
];
363 int ce_len
= ce_namelen(ce
);
365 if (!S_ISGITLINK(ce
->ce_mode
))
368 if (item
->len
<= ce_len
|| item
->match
[ce_len
] != '/' ||
369 memcmp(ce
->name
, item
->match
, ce_len
))
372 if (item
->len
== ce_len
+ 1) {
373 /* strip trailing slash */
375 item
->match
[item
->len
] = '\0';
377 die(_("Pathspec '%s' is in submodule '%.*s'"),
378 item
->original
, ce_len
, ce
->name
);
383 static void die_inside_submodule_path(struct pathspec_item
*item
)
387 for (i
= 0; i
< active_nr
; i
++) {
388 struct cache_entry
*ce
= active_cache
[i
];
389 int ce_len
= ce_namelen(ce
);
391 if (!S_ISGITLINK(ce
->ce_mode
))
394 if (item
->len
< ce_len
||
395 !(item
->match
[ce_len
] == '/' || item
->match
[ce_len
] == '\0') ||
396 memcmp(ce
->name
, item
->match
, ce_len
))
399 die(_("Pathspec '%s' is in submodule '%.*s'"),
400 item
->original
, ce_len
, ce
->name
);
405 * Perform the initialization of a pathspec_item based on a pathspec element.
407 static void init_pathspec_item(struct pathspec_item
*item
, unsigned flags
,
408 const char *prefix
, int prefixlen
,
411 unsigned magic
= 0, element_magic
= 0;
412 const char *copyfrom
= elt
;
414 int pathspec_prefix
= -1;
416 item
->attr_check
= NULL
;
417 item
->attr_match
= NULL
;
418 item
->attr_match_nr
= 0;
420 /* PATHSPEC_LITERAL_PATH ignores magic */
421 if (flags
& PATHSPEC_LITERAL_PATH
) {
422 magic
= PATHSPEC_LITERAL
;
424 copyfrom
= parse_element_magic(&element_magic
,
428 magic
|= element_magic
;
429 magic
|= get_global_magic(element_magic
);
434 if (pathspec_prefix
>= 0 &&
435 (prefixlen
|| (prefix
&& *prefix
)))
436 die("BUG: 'prefix' magic is supposed to be used at worktree's root");
438 if ((magic
& PATHSPEC_LITERAL
) && (magic
& PATHSPEC_GLOB
))
439 die(_("%s: 'literal' and 'glob' are incompatible"), elt
);
441 /* Create match string which will be used for pathspec matching */
442 if (pathspec_prefix
>= 0) {
443 match
= xstrdup(copyfrom
);
444 prefixlen
= pathspec_prefix
;
445 } else if (magic
& PATHSPEC_FROMTOP
) {
446 match
= xstrdup(copyfrom
);
449 match
= prefix_path_gently(prefix
, prefixlen
,
450 &prefixlen
, copyfrom
);
452 die(_("%s: '%s' is outside repository"), elt
, copyfrom
);
456 item
->len
= strlen(item
->match
);
457 item
->prefix
= prefixlen
;
460 * Prefix the pathspec (keep all magic) and assign to
461 * original. Useful for passing to another command.
463 if ((flags
& PATHSPEC_PREFIX_ORIGIN
) &&
464 prefixlen
&& !get_literal_global()) {
465 struct strbuf sb
= STRBUF_INIT
;
467 /* Preserve the actual prefix length of each pattern */
468 prefix_magic(&sb
, prefixlen
, element_magic
);
470 strbuf_addstr(&sb
, match
);
471 item
->original
= strbuf_detach(&sb
, NULL
);
473 item
->original
= xstrdup(elt
);
476 if (flags
& PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP
)
477 strip_submodule_slash_cheap(item
);
479 if (flags
& PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE
)
480 strip_submodule_slash_expensive(item
);
482 if (magic
& PATHSPEC_LITERAL
) {
483 item
->nowildcard_len
= item
->len
;
485 item
->nowildcard_len
= simple_length(item
->match
);
486 if (item
->nowildcard_len
< prefixlen
)
487 item
->nowildcard_len
= prefixlen
;
491 if (magic
& PATHSPEC_GLOB
) {
493 * FIXME: should we enable ONESTAR in _GLOB for
494 * pattern "* * / * . c"?
497 if (item
->nowildcard_len
< item
->len
&&
498 item
->match
[item
->nowildcard_len
] == '*' &&
499 no_wildcard(item
->match
+ item
->nowildcard_len
+ 1))
500 item
->flags
|= PATHSPEC_ONESTAR
;
503 /* sanity checks, pathspec matchers assume these are sane */
504 if (item
->nowildcard_len
> item
->len
||
505 item
->prefix
> item
->len
) {
507 * This case can be triggered by the user pointing us to a
508 * pathspec inside a submodule, which is an input error.
509 * Detect that here and complain, but fallback in the
510 * non-submodule case to a BUG, as we have no idea what
511 * would trigger that.
513 die_inside_submodule_path(item
);
514 die ("BUG: item->nowildcard_len > item->len || item->prefix > item->len)");
518 static int pathspec_item_cmp(const void *a_
, const void *b_
)
520 struct pathspec_item
*a
, *b
;
522 a
= (struct pathspec_item
*)a_
;
523 b
= (struct pathspec_item
*)b_
;
524 return strcmp(a
->match
, b
->match
);
527 static void NORETURN
unsupported_magic(const char *pattern
,
530 struct strbuf sb
= STRBUF_INIT
;
532 for (i
= 0; i
< ARRAY_SIZE(pathspec_magic
); i
++) {
533 const struct pathspec_magic
*m
= pathspec_magic
+ i
;
534 if (!(magic
& m
->bit
))
537 strbuf_addstr(&sb
, ", ");
540 strbuf_addf(&sb
, _("'%s' (mnemonic: '%c')"),
541 m
->name
, m
->mnemonic
);
543 strbuf_addf(&sb
, "'%s'", m
->name
);
546 * We may want to substitute "this command" with a command
547 * name. E.g. when add--interactive dies when running
550 die(_("%s: pathspec magic not supported by this command: %s"),
555 * Given command line arguments and a prefix, convert the input to
556 * pathspec. die() if any magic in magic_mask is used.
558 void parse_pathspec(struct pathspec
*pathspec
,
559 unsigned magic_mask
, unsigned flags
,
560 const char *prefix
, const char **argv
)
562 struct pathspec_item
*item
;
563 const char *entry
= argv
? *argv
: NULL
;
564 int i
, n
, prefixlen
, warn_empty_string
, nr_exclude
= 0;
566 memset(pathspec
, 0, sizeof(*pathspec
));
568 if (flags
& PATHSPEC_MAXDEPTH_VALID
)
569 pathspec
->magic
|= PATHSPEC_MAXDEPTH
;
571 /* No arguments, no prefix -> no pathspec */
572 if (!entry
&& !prefix
)
575 if ((flags
& PATHSPEC_PREFER_CWD
) &&
576 (flags
& PATHSPEC_PREFER_FULL
))
577 die("BUG: PATHSPEC_PREFER_CWD and PATHSPEC_PREFER_FULL are incompatible");
579 /* No arguments with prefix -> prefix pathspec */
581 if (flags
& PATHSPEC_PREFER_FULL
)
584 if (!(flags
& PATHSPEC_PREFER_CWD
))
585 die("BUG: PATHSPEC_PREFER_CWD requires arguments");
587 pathspec
->items
= item
= xcalloc(1, sizeof(*item
));
588 item
->match
= xstrdup(prefix
);
589 item
->original
= xstrdup(prefix
);
590 item
->nowildcard_len
= item
->len
= strlen(prefix
);
591 item
->prefix
= item
->len
;
597 warn_empty_string
= 1;
599 if (*argv
[n
] == '\0' && warn_empty_string
) {
600 warning(_("empty strings as pathspecs will be made invalid in upcoming releases. "
601 "please use . instead if you meant to match all paths"));
602 warn_empty_string
= 0;
608 ALLOC_ARRAY(pathspec
->items
, n
+ 1);
609 item
= pathspec
->items
;
610 prefixlen
= prefix
? strlen(prefix
) : 0;
612 for (i
= 0; i
< n
; i
++) {
615 init_pathspec_item(item
+ i
, flags
, prefix
, prefixlen
, entry
);
617 if (item
[i
].magic
& PATHSPEC_EXCLUDE
)
619 if (item
[i
].magic
& magic_mask
)
620 unsupported_magic(entry
, item
[i
].magic
& magic_mask
);
622 if ((flags
& PATHSPEC_SYMLINK_LEADING_PATH
) &&
623 has_symlink_leading_path(item
[i
].match
, item
[i
].len
)) {
624 die(_("pathspec '%s' is beyond a symbolic link"), entry
);
627 if (item
[i
].nowildcard_len
< item
[i
].len
)
628 pathspec
->has_wildcard
= 1;
629 pathspec
->magic
|= item
[i
].magic
;
633 * If everything is an exclude pattern, add one positive pattern
634 * that matches everyting. We allocated an extra one for this.
636 if (nr_exclude
== n
) {
637 int plen
= (!(flags
& PATHSPEC_PREFER_CWD
)) ? 0 : prefixlen
;
638 init_pathspec_item(item
+ n
, 0, prefix
, plen
, "");
642 if (pathspec
->magic
& PATHSPEC_MAXDEPTH
) {
643 if (flags
& PATHSPEC_KEEP_ORDER
)
644 die("BUG: PATHSPEC_MAXDEPTH_VALID and PATHSPEC_KEEP_ORDER are incompatible");
645 QSORT(pathspec
->items
, pathspec
->nr
, pathspec_item_cmp
);
649 void copy_pathspec(struct pathspec
*dst
, const struct pathspec
*src
)
654 ALLOC_ARRAY(dst
->items
, dst
->nr
);
655 COPY_ARRAY(dst
->items
, src
->items
, dst
->nr
);
657 for (i
= 0; i
< dst
->nr
; i
++) {
658 struct pathspec_item
*d
= &dst
->items
[i
];
659 struct pathspec_item
*s
= &src
->items
[i
];
661 d
->match
= xstrdup(s
->match
);
662 d
->original
= xstrdup(s
->original
);
664 ALLOC_ARRAY(d
->attr_match
, d
->attr_match_nr
);
665 COPY_ARRAY(d
->attr_match
, s
->attr_match
, d
->attr_match_nr
);
666 for (j
= 0; j
< d
->attr_match_nr
; j
++) {
667 const char *value
= s
->attr_match
[j
].value
;
668 d
->attr_match
[j
].value
= xstrdup_or_null(value
);
671 d
->attr_check
= attr_check_dup(s
->attr_check
);
675 void clear_pathspec(struct pathspec
*pathspec
)
679 for (i
= 0; i
< pathspec
->nr
; i
++) {
680 free(pathspec
->items
[i
].match
);
681 free(pathspec
->items
[i
].original
);
683 for (j
= 0; j
< pathspec
->items
[j
].attr_match_nr
; j
++)
684 free(pathspec
->items
[i
].attr_match
[j
].value
);
685 free(pathspec
->items
[i
].attr_match
);
687 if (pathspec
->items
[i
].attr_check
)
688 attr_check_free(pathspec
->items
[i
].attr_check
);
691 free(pathspec
->items
);
692 pathspec
->items
= NULL
;