2 * Handle git attributes. See gitattributes(5) for a description of
3 * the file syntax, and Documentation/technical/api-gitattributes.txt
4 * for a description of the API.
6 * One basic design decision here is that we are not going to support
7 * an insanely large number of attributes.
10 #define NO_THE_INDEX_COMPATIBILITY_MACROS
16 const char git_attr__true[] = "(builtin)true";
17 const char git_attr__false[] = "\0(builtin)false";
18 static const char git_attr__unknown[] = "(builtin)unknown";
19 #define ATTR__TRUE git_attr__true
20 #define ATTR__FALSE git_attr__false
21 #define ATTR__UNSET NULL
22 #define ATTR__UNKNOWN git_attr__unknown
24 /* This is a randomly chosen prime. */
32 struct git_attr *next;
35 char name[FLEX_ARRAY];
39 static struct git_attr_check *check_all_attr;
40 static struct git_attr *(git_attr_hash[HASHSIZE]);
42 char *git_attr_name(struct git_attr *attr)
47 static unsigned hash_name(const char *name, int namelen)
53 val = ((val << 7) | (val >> 22)) ^ c;
58 static int invalid_attr_name(const char *name, int namelen)
61 * Attribute name cannot begin with '-' and must consist of
62 * characters from [-A-Za-z0-9_.].
64 if (namelen <= 0 || *name == '-')
68 if (! (ch == '-' || ch == '.' || ch == '_' ||
69 ('0' <= ch && ch <= '9') ||
70 ('a' <= ch && ch <= 'z') ||
71 ('A' <= ch && ch <= 'Z')) )
77 static struct git_attr *git_attr_internal(const char *name, int len)
79 unsigned hval = hash_name(name, len);
80 unsigned pos = hval % HASHSIZE;
83 for (a = git_attr_hash[pos]; a; a = a->next) {
85 !memcmp(a->name, name, len) && !a->name[len])
89 if (invalid_attr_name(name, len))
92 a = xmalloc(sizeof(*a) + len + 1);
93 memcpy(a->name, name, len);
96 a->next = git_attr_hash[pos];
97 a->attr_nr = attr_nr++;
98 git_attr_hash[pos] = a;
100 check_all_attr = xrealloc(check_all_attr,
101 sizeof(*check_all_attr) * attr_nr);
102 check_all_attr[a->attr_nr].attr = a;
103 check_all_attr[a->attr_nr].value = ATTR__UNKNOWN;
107 struct git_attr *git_attr(const char *name)
109 return git_attr_internal(name, strlen(name));
112 /* What does a matched pattern decide? */
114 struct git_attr *attr;
119 * One rule, as from a .gitattributes file.
121 * If is_macro is true, then u.attr is a pointer to the git_attr being
124 * If is_macro is false, then u.pattern points at the filename pattern
125 * to which the rule applies. (The memory pointed to is part of the
126 * memory block allocated for the match_attr instance.)
128 * In either case, num_attr is the number of attributes affected by
129 * this rule, and state is an array listing them. The attributes are
130 * listed as they appear in the file (macros unexpanded).
135 struct git_attr *attr;
139 struct attr_state state[FLEX_ARRAY];
142 static const char blank[] = " \t\r\n";
145 * Parse a whitespace-delimited attribute state (i.e., "attr",
146 * "-attr", "!attr", or "attr=value") from the string starting at src.
147 * If e is not NULL, write the results to *e. Return a pointer to the
148 * remainder of the string (with leading whitespace removed), or NULL
149 * if there was an error.
151 static const char *parse_attr(const char *src, int lineno, const char *cp,
152 struct attr_state *e)
154 const char *ep, *equals;
157 ep = cp + strcspn(cp, blank);
158 equals = strchr(cp, '=');
159 if (equals && ep < equals)
166 if (*cp == '-' || *cp == '!') {
170 if (invalid_attr_name(cp, len)) {
172 "%.*s is not a valid attribute name: %s:%d\n",
173 len, cp, src, lineno);
177 if (*cp == '-' || *cp == '!') {
178 e->setto = (*cp == '-') ? ATTR__FALSE : ATTR__UNSET;
183 e->setto = ATTR__TRUE;
185 e->setto = xmemdupz(equals + 1, ep - equals - 1);
187 e->attr = git_attr_internal(cp, len);
189 return ep + strspn(ep, blank);
192 static struct match_attr *parse_attr_line(const char *line, const char *src,
193 int lineno, int macro_ok)
197 const char *cp, *name, *states;
198 struct match_attr *res = NULL;
201 cp = line + strspn(line, blank);
202 if (!*cp || *cp == '#')
205 namelen = strcspn(name, blank);
206 if (strlen(ATTRIBUTE_MACRO_PREFIX) < namelen &&
207 !prefixcmp(name, ATTRIBUTE_MACRO_PREFIX)) {
209 fprintf(stderr, "%s not allowed: %s:%d\n",
214 name += strlen(ATTRIBUTE_MACRO_PREFIX);
215 name += strspn(name, blank);
216 namelen = strcspn(name, blank);
217 if (invalid_attr_name(name, namelen)) {
219 "%.*s is not a valid attribute name: %s:%d\n",
220 namelen, name, src, lineno);
227 states = name + namelen;
228 states += strspn(states, blank);
230 /* First pass to count the attr_states */
231 for (cp = states, num_attr = 0; *cp; num_attr++) {
232 cp = parse_attr(src, lineno, cp, NULL);
239 sizeof(struct attr_state) * num_attr +
240 (is_macro ? 0 : namelen + 1));
242 res->u.attr = git_attr_internal(name, namelen);
244 res->u.pattern = (char *)&(res->state[num_attr]);
245 memcpy(res->u.pattern, name, namelen);
246 res->u.pattern[namelen] = 0;
248 res->is_macro = is_macro;
249 res->num_attr = num_attr;
251 /* Second pass to fill the attr_states */
252 for (cp = states, i = 0; *cp; i++) {
253 cp = parse_attr(src, lineno, cp, &(res->state[i]));
260 * Like info/exclude and .gitignore, the attribute information can
261 * come from many places.
263 * (1) .gitattribute file of the same directory;
264 * (2) .gitattribute file of the parent directory if (1) does not have
265 * any match; this goes recursively upwards, just like .gitignore.
266 * (3) $GIT_DIR/info/attributes, which overrides both of the above.
268 * In the same file, later entries override the earlier match, so in the
269 * global list, we would have entries from info/attributes the earliest
270 * (reading the file from top to bottom), .gitattribute of the root
271 * directory (again, reading the file from top to bottom) down to the
272 * current directory, and then scan the list backwards to find the first match.
273 * This is exactly the same as what excluded() does in dir.c to deal with
277 static struct attr_stack {
278 struct attr_stack *prev;
280 unsigned num_matches;
282 struct match_attr **attrs;
285 static void free_attr_elem(struct attr_stack *e)
289 for (i = 0; i < e->num_matches; i++) {
290 struct match_attr *a = e->attrs[i];
292 for (j = 0; j < a->num_attr; j++) {
293 const char *setto = a->state[j].setto;
294 if (setto == ATTR__TRUE ||
295 setto == ATTR__FALSE ||
296 setto == ATTR__UNSET ||
297 setto == ATTR__UNKNOWN)
300 free((char *) setto);
307 static const char *builtin_attr[] = {
308 "[attr]binary -diff -text",
312 static void handle_attr_line(struct attr_stack *res,
318 struct match_attr *a;
320 a = parse_attr_line(line, src, lineno, macro_ok);
323 if (res->alloc <= res->num_matches) {
324 res->alloc = alloc_nr(res->num_matches);
325 res->attrs = xrealloc(res->attrs,
326 sizeof(struct match_attr *) *
329 res->attrs[res->num_matches++] = a;
332 static struct attr_stack *read_attr_from_array(const char **list)
334 struct attr_stack *res;
338 res = xcalloc(1, sizeof(*res));
339 while ((line = *(list++)) != NULL)
340 handle_attr_line(res, line, "[builtin]", ++lineno, 1);
344 static enum git_attr_direction direction;
345 static struct index_state *use_index;
347 static struct attr_stack *read_attr_from_file(const char *path, int macro_ok)
349 FILE *fp = fopen(path, "r");
350 struct attr_stack *res;
356 res = xcalloc(1, sizeof(*res));
357 while (fgets(buf, sizeof(buf), fp))
358 handle_attr_line(res, buf, path, ++lineno, macro_ok);
363 static void *read_index_data(const char *path)
367 enum object_type type;
369 struct index_state *istate = use_index ? use_index : &the_index;
372 pos = index_name_pos(istate, path, len);
375 * We might be in the middle of a merge, in which
376 * case we would read stage #2 (ours).
380 (pos < 0 && i < istate->cache_nr &&
381 !strcmp(istate->cache[i]->name, path));
383 if (ce_stage(istate->cache[i]) == 2)
388 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
389 if (!data || type != OBJ_BLOB) {
396 static struct attr_stack *read_attr_from_index(const char *path, int macro_ok)
398 struct attr_stack *res;
402 buf = read_index_data(path);
406 res = xcalloc(1, sizeof(*res));
407 for (sp = buf; *sp; ) {
410 for (ep = sp; *ep && *ep != '\n'; ep++)
412 more = (*ep == '\n');
414 handle_attr_line(res, sp, path, ++lineno, macro_ok);
421 static struct attr_stack *read_attr(const char *path, int macro_ok)
423 struct attr_stack *res;
425 if (direction == GIT_ATTR_CHECKOUT) {
426 res = read_attr_from_index(path, macro_ok);
428 res = read_attr_from_file(path, macro_ok);
430 else if (direction == GIT_ATTR_CHECKIN) {
431 res = read_attr_from_file(path, macro_ok);
434 * There is no checked out .gitattributes file there, but
435 * we might have it in the index. We allow operation in a
436 * sparsely checked out work tree, so read from it.
438 res = read_attr_from_index(path, macro_ok);
441 res = read_attr_from_index(path, macro_ok);
443 res = xcalloc(1, sizeof(*res));
448 static void debug_info(const char *what, struct attr_stack *elem)
450 fprintf(stderr, "%s: %s\n", what, elem->origin ? elem->origin : "()");
452 static void debug_set(const char *what, const char *match, struct git_attr *attr, const void *v)
454 const char *value = v;
456 if (ATTR_TRUE(value))
458 else if (ATTR_FALSE(value))
460 else if (ATTR_UNSET(value))
461 value = "unspecified";
463 fprintf(stderr, "%s: %s => %s (%s)\n",
464 what, attr->name, (char *) value, match);
466 #define debug_push(a) debug_info("push", (a))
467 #define debug_pop(a) debug_info("pop", (a))
469 #define debug_push(a) do { ; } while (0)
470 #define debug_pop(a) do { ; } while (0)
471 #define debug_set(a,b,c,d) do { ; } while (0)
474 static void drop_attr_stack(void)
477 struct attr_stack *elem = attr_stack;
478 attr_stack = elem->prev;
479 free_attr_elem(elem);
483 static const char *git_etc_gitattributes(void)
485 static const char *system_wide;
487 system_wide = system_path(ETC_GITATTRIBUTES);
491 static int git_attr_system(void)
493 return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
496 static void bootstrap_attr_stack(void)
498 struct attr_stack *elem;
503 elem = read_attr_from_array(builtin_attr);
505 elem->prev = attr_stack;
508 if (git_attr_system()) {
509 elem = read_attr_from_file(git_etc_gitattributes(), 1);
512 elem->prev = attr_stack;
517 if (git_attributes_file) {
518 elem = read_attr_from_file(git_attributes_file, 1);
521 elem->prev = attr_stack;
526 if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
527 elem = read_attr(GITATTRIBUTES_FILE, 1);
528 elem->origin = xstrdup("");
529 elem->prev = attr_stack;
534 elem = read_attr_from_file(git_path(INFOATTRIBUTES_FILE), 1);
536 elem = xcalloc(1, sizeof(*elem));
538 elem->prev = attr_stack;
542 static void prepare_attr_stack(const char *path)
544 struct attr_stack *elem, *info;
548 cp = strrchr(path, '/');
555 * At the bottom of the attribute stack is the built-in
556 * set of attribute definitions, followed by the contents
557 * of $(prefix)/etc/gitattributes and a file specified by
558 * core.attributesfile. Then, contents from
559 * .gitattribute files from directories closer to the
560 * root to the ones in deeper directories are pushed
561 * to the stack. Finally, at the very top of the stack
562 * we always keep the contents of $GIT_DIR/info/attributes.
564 * When checking, we use entries from near the top of the
565 * stack, preferring $GIT_DIR/info/attributes, then
566 * .gitattributes in deeper directories to shallower ones,
567 * and finally use the built-in set as the default.
569 bootstrap_attr_stack();
572 * Pop the "info" one that is always at the top of the stack.
575 attr_stack = info->prev;
578 * Pop the ones from directories that are not the prefix of
579 * the path we are checking. Break out of the loop when we see
580 * the root one (whose origin is an empty string "") or the builtin
581 * one (whose origin is NULL) without popping it.
583 while (attr_stack->origin) {
584 int namelen = strlen(attr_stack->origin);
587 if (namelen <= dirlen &&
588 !strncmp(elem->origin, path, namelen) &&
589 (!namelen || path[namelen] == '/'))
593 attr_stack = elem->prev;
594 free_attr_elem(elem);
598 * Read from parent directories and push them down
600 if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
602 * bootstrap_attr_stack() should have added, and the
603 * above loop should have stopped before popping, the
604 * root element whose attr_stack->origin is set to an
607 struct strbuf pathbuf = STRBUF_INIT;
609 assert(attr_stack->origin);
611 len = strlen(attr_stack->origin);
614 cp = memchr(path + len + 1, '/', dirlen - len - 1);
617 strbuf_add(&pathbuf, path, cp - path);
618 strbuf_addch(&pathbuf, '/');
619 strbuf_addstr(&pathbuf, GITATTRIBUTES_FILE);
620 elem = read_attr(pathbuf.buf, 0);
621 strbuf_setlen(&pathbuf, cp - path);
622 elem->origin = strbuf_detach(&pathbuf, NULL);
623 elem->prev = attr_stack;
628 strbuf_release(&pathbuf);
632 * Finally push the "info" one at the top of the stack.
634 info->prev = attr_stack;
638 static int path_matches(const char *pathname, int pathlen,
640 const char *base, int baselen)
642 if (!strchr(pattern, '/')) {
644 const char *basename = strrchr(pathname, '/');
645 basename = basename ? basename + 1 : pathname;
646 return (fnmatch_icase(pattern, basename, 0) == 0);
649 * match with FNM_PATHNAME; the pattern has base implicitly
654 if (pathlen < baselen ||
655 (baselen && pathname[baselen] != '/') ||
656 strncmp(pathname, base, baselen))
660 return fnmatch_icase(pattern, pathname + baselen, FNM_PATHNAME) == 0;
663 static int macroexpand_one(int attr_nr, int rem);
665 static int fill_one(const char *what, struct match_attr *a, int rem)
667 struct git_attr_check *check = check_all_attr;
670 for (i = a->num_attr - 1; 0 < rem && 0 <= i; i--) {
671 struct git_attr *attr = a->state[i].attr;
672 const char **n = &(check[attr->attr_nr].value);
673 const char *v = a->state[i].setto;
675 if (*n == ATTR__UNKNOWN) {
677 a->is_macro ? a->u.attr->name : a->u.pattern,
681 rem = macroexpand_one(attr->attr_nr, rem);
687 static int fill(const char *path, int pathlen, struct attr_stack *stk, int rem)
690 const char *base = stk->origin ? stk->origin : "";
692 for (i = stk->num_matches - 1; 0 < rem && 0 <= i; i--) {
693 struct match_attr *a = stk->attrs[i];
696 if (path_matches(path, pathlen,
697 a->u.pattern, base, strlen(base)))
698 rem = fill_one("fill", a, rem);
703 static int macroexpand_one(int attr_nr, int rem)
705 struct attr_stack *stk;
706 struct match_attr *a = NULL;
709 if (check_all_attr[attr_nr].value != ATTR__TRUE)
712 for (stk = attr_stack; !a && stk; stk = stk->prev)
713 for (i = stk->num_matches - 1; !a && 0 <= i; i--) {
714 struct match_attr *ma = stk->attrs[i];
717 if (ma->u.attr->attr_nr == attr_nr)
722 rem = fill_one("expand", a, rem);
728 * Collect all attributes for path into the array pointed to by
731 static void collect_all_attrs(const char *path)
733 struct attr_stack *stk;
736 prepare_attr_stack(path);
737 for (i = 0; i < attr_nr; i++)
738 check_all_attr[i].value = ATTR__UNKNOWN;
740 pathlen = strlen(path);
742 for (stk = attr_stack; 0 < rem && stk; stk = stk->prev)
743 rem = fill(path, pathlen, stk, rem);
746 int git_check_attr(const char *path, int num, struct git_attr_check *check)
750 collect_all_attrs(path);
752 for (i = 0; i < num; i++) {
753 const char *value = check_all_attr[check[i].attr->attr_nr].value;
754 if (value == ATTR__UNKNOWN)
756 check[i].value = value;
762 int git_all_attrs(const char *path, int *num, struct git_attr_check **check)
766 collect_all_attrs(path);
768 /* Count the number of attributes that are set. */
770 for (i = 0; i < attr_nr; i++) {
771 const char *value = check_all_attr[i].value;
772 if (value != ATTR__UNSET && value != ATTR__UNKNOWN)
776 *check = xmalloc(sizeof(**check) * count);
778 for (i = 0; i < attr_nr; i++) {
779 const char *value = check_all_attr[i].value;
780 if (value != ATTR__UNSET && value != ATTR__UNKNOWN) {
781 (*check)[j].attr = check_all_attr[i].attr;
782 (*check)[j].value = value;
790 void git_attr_set_direction(enum git_attr_direction new, struct index_state *istate)
792 enum git_attr_direction old = direction;
794 if (is_bare_repository() && new != GIT_ATTR_INDEX)
795 die("BUG: non-INDEX attr direction in a bare repo");