1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
6 const char git_attr__true[] = "(builtin)true";
7 const char git_attr__false[] = "\0(builtin)false";
8 static const char git_attr__unknown[] = "(builtin)unknown";
9 #define ATTR__TRUE git_attr__true
10 #define ATTR__FALSE git_attr__false
11 #define ATTR__UNSET NULL
12 #define ATTR__UNKNOWN git_attr__unknown
14 static const char *attributes_file;
17 * The basic design decision here is that we are not going to have
18 * insanely large number of attributes.
20 * This is a randomly chosen prime.
29 struct git_attr *next;
32 char name[FLEX_ARRAY];
36 static struct git_attr_check *check_all_attr;
37 static struct git_attr *(git_attr_hash[HASHSIZE]);
39 static unsigned hash_name(const char *name, int namelen)
45 val = ((val << 7) | (val >> 22)) ^ c;
50 static int invalid_attr_name(const char *name, int namelen)
53 * Attribute name cannot begin with '-' and from
54 * [-A-Za-z0-9_.]. We'd specifically exclude '=' for now,
55 * as we might later want to allow non-binary value for
56 * attributes, e.g. "*.svg merge=special-merge-program-for-svg"
62 if (! (ch == '-' || ch == '.' || ch == '_' ||
63 ('0' <= ch && ch <= '9') ||
64 ('a' <= ch && ch <= 'z') ||
65 ('A' <= ch && ch <= 'Z')) )
71 static struct git_attr *git_attr_internal(const char *name, int len)
73 unsigned hval = hash_name(name, len);
74 unsigned pos = hval % HASHSIZE;
77 for (a = git_attr_hash[pos]; a; a = a->next) {
79 !memcmp(a->name, name, len) && !a->name[len])
83 if (invalid_attr_name(name, len))
86 a = xmalloc(sizeof(*a) + len + 1);
87 memcpy(a->name, name, len);
90 a->next = git_attr_hash[pos];
91 a->attr_nr = attr_nr++;
92 git_attr_hash[pos] = a;
94 check_all_attr = xrealloc(check_all_attr,
95 sizeof(*check_all_attr) * attr_nr);
96 check_all_attr[a->attr_nr].attr = a;
97 check_all_attr[a->attr_nr].value = ATTR__UNKNOWN;
101 struct git_attr *git_attr(const char *name)
103 return git_attr_internal(name, strlen(name));
107 * .gitattributes file is one line per record, each of which is
111 * (3) whitespace separated list of attribute names, each of which
112 * could be prefixed with '-' to mean "set to false", '!' to mean
116 /* What does a matched pattern decide? */
118 struct git_attr *attr;
125 struct git_attr *attr;
129 struct attr_state state[FLEX_ARRAY];
132 static const char blank[] = " \t\r\n";
134 static const char *parse_attr(const char *src, int lineno, const char *cp,
135 int *num_attr, struct match_attr *res)
137 const char *ep, *equals;
140 ep = cp + strcspn(cp, blank);
141 equals = strchr(cp, '=');
142 if (equals && ep < equals)
149 if (*cp == '-' || *cp == '!') {
153 if (invalid_attr_name(cp, len)) {
155 "%.*s is not a valid attribute name: %s:%d\n",
156 len, cp, src, lineno);
160 struct attr_state *e;
162 e = &(res->state[*num_attr]);
163 if (*cp == '-' || *cp == '!') {
164 e->setto = (*cp == '-') ? ATTR__FALSE : ATTR__UNSET;
169 e->setto = ATTR__TRUE;
171 e->setto = xmemdupz(equals + 1, ep - equals - 1);
173 e->attr = git_attr_internal(cp, len);
176 return ep + strspn(ep, blank);
179 static struct match_attr *parse_attr_line(const char *line, const char *src,
180 int lineno, int macro_ok)
184 const char *cp, *name;
185 struct match_attr *res = NULL;
189 cp = line + strspn(line, blank);
190 if (!*cp || *cp == '#')
193 namelen = strcspn(name, blank);
194 if (strlen(ATTRIBUTE_MACRO_PREFIX) < namelen &&
195 !prefixcmp(name, ATTRIBUTE_MACRO_PREFIX)) {
197 fprintf(stderr, "%s not allowed: %s:%d\n",
202 name += strlen(ATTRIBUTE_MACRO_PREFIX);
203 name += strspn(name, blank);
204 namelen = strcspn(name, blank);
205 if (invalid_attr_name(name, namelen)) {
207 "%.*s is not a valid attribute name: %s:%d\n",
208 namelen, name, src, lineno);
215 for (pass = 0; pass < 2; pass++) {
216 /* pass 0 counts and allocates, pass 1 fills */
219 cp = cp + strspn(cp, blank);
221 cp = parse_attr(src, lineno, cp, &num_attr, res);
229 sizeof(struct attr_state) * num_attr +
230 (is_macro ? 0 : namelen + 1));
232 res->u.attr = git_attr_internal(name, namelen);
234 res->u.pattern = (char *)&(res->state[num_attr]);
235 memcpy(res->u.pattern, name, namelen);
236 res->u.pattern[namelen] = 0;
238 res->is_macro = is_macro;
239 res->num_attr = num_attr;
245 * Like info/exclude and .gitignore, the attribute information can
246 * come from many places.
248 * (1) .gitattribute file of the same directory;
249 * (2) .gitattribute file of the parent directory if (1) does not have
250 * any match; this goes recursively upwards, just like .gitignore.
251 * (3) $GIT_DIR/info/attributes, which overrides both of the above.
253 * In the same file, later entries override the earlier match, so in the
254 * global list, we would have entries from info/attributes the earliest
255 * (reading the file from top to bottom), .gitattribute of the root
256 * directory (again, reading the file from top to bottom) down to the
257 * current directory, and then scan the list backwards to find the first match.
258 * This is exactly the same as what excluded() does in dir.c to deal with
262 static struct attr_stack {
263 struct attr_stack *prev;
265 unsigned num_matches;
267 struct match_attr **attrs;
270 static void free_attr_elem(struct attr_stack *e)
274 for (i = 0; i < e->num_matches; i++) {
275 struct match_attr *a = e->attrs[i];
277 for (j = 0; j < a->num_attr; j++) {
278 const char *setto = a->state[j].setto;
279 if (setto == ATTR__TRUE ||
280 setto == ATTR__FALSE ||
281 setto == ATTR__UNSET ||
282 setto == ATTR__UNKNOWN)
285 free((char *) setto);
293 static const char *builtin_attr[] = {
294 "[attr]binary -diff -text",
298 static void handle_attr_line(struct attr_stack *res,
304 struct match_attr *a;
306 a = parse_attr_line(line, src, lineno, macro_ok);
309 if (res->alloc <= res->num_matches) {
310 res->alloc = alloc_nr(res->num_matches);
311 res->attrs = xrealloc(res->attrs,
312 sizeof(struct match_attr *) *
315 res->attrs[res->num_matches++] = a;
318 static struct attr_stack *read_attr_from_array(const char **list)
320 struct attr_stack *res;
324 res = xcalloc(1, sizeof(*res));
325 while ((line = *(list++)) != NULL)
326 handle_attr_line(res, line, "[builtin]", ++lineno, 1);
330 static enum git_attr_direction direction;
331 static struct index_state *use_index;
333 static struct attr_stack *read_attr_from_file(const char *path, int macro_ok)
335 FILE *fp = fopen(path, "r");
336 struct attr_stack *res;
342 res = xcalloc(1, sizeof(*res));
343 while (fgets(buf, sizeof(buf), fp))
344 handle_attr_line(res, buf, path, ++lineno, macro_ok);
349 static void *read_index_data(const char *path)
353 enum object_type type;
355 struct index_state *istate = use_index ? use_index : &the_index;
358 pos = index_name_pos(istate, path, len);
361 * We might be in the middle of a merge, in which
362 * case we would read stage #2 (ours).
366 (pos < 0 && i < istate->cache_nr &&
367 !strcmp(istate->cache[i]->name, path));
369 if (ce_stage(istate->cache[i]) == 2)
374 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
375 if (!data || type != OBJ_BLOB) {
382 static struct attr_stack *read_attr_from_index(const char *path, int macro_ok)
384 struct attr_stack *res;
388 buf = read_index_data(path);
392 res = xcalloc(1, sizeof(*res));
393 for (sp = buf; *sp; ) {
396 for (ep = sp; *ep && *ep != '\n'; ep++)
398 more = (*ep == '\n');
400 handle_attr_line(res, sp, path, ++lineno, macro_ok);
407 static struct attr_stack *read_attr(const char *path, int macro_ok)
409 struct attr_stack *res;
411 if (direction == GIT_ATTR_CHECKOUT) {
412 res = read_attr_from_index(path, macro_ok);
414 res = read_attr_from_file(path, macro_ok);
416 else if (direction == GIT_ATTR_CHECKIN) {
417 res = read_attr_from_file(path, macro_ok);
420 * There is no checked out .gitattributes file there, but
421 * we might have it in the index. We allow operation in a
422 * sparsely checked out work tree, so read from it.
424 res = read_attr_from_index(path, macro_ok);
427 res = read_attr_from_index(path, macro_ok);
429 res = xcalloc(1, sizeof(*res));
434 static void debug_info(const char *what, struct attr_stack *elem)
436 fprintf(stderr, "%s: %s\n", what, elem->origin ? elem->origin : "()");
438 static void debug_set(const char *what, const char *match, struct git_attr *attr, const void *v)
440 const char *value = v;
442 if (ATTR_TRUE(value))
444 else if (ATTR_FALSE(value))
446 else if (ATTR_UNSET(value))
447 value = "unspecified";
449 fprintf(stderr, "%s: %s => %s (%s)\n",
450 what, attr->name, (char *) value, match);
452 #define debug_push(a) debug_info("push", (a))
453 #define debug_pop(a) debug_info("pop", (a))
455 #define debug_push(a) do { ; } while (0)
456 #define debug_pop(a) do { ; } while (0)
457 #define debug_set(a,b,c,d) do { ; } while (0)
460 static void drop_attr_stack(void)
463 struct attr_stack *elem = attr_stack;
464 attr_stack = elem->prev;
465 free_attr_elem(elem);
469 static const char *git_etc_gitattributes(void)
471 static const char *system_wide;
473 system_wide = system_path(ETC_GITATTRIBUTES);
477 static int git_attr_system(void)
479 return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
482 static int git_attr_config(const char *var, const char *value, void *dummy)
484 if (!strcmp(var, "core.attributesfile"))
485 return git_config_pathname(&attributes_file, var, value);
490 static void bootstrap_attr_stack(void)
492 struct attr_stack *elem;
497 elem = read_attr_from_array(builtin_attr);
499 elem->prev = attr_stack;
502 if (git_attr_system()) {
503 elem = read_attr_from_file(git_etc_gitattributes(), 1);
506 elem->prev = attr_stack;
511 git_config(git_attr_config, NULL);
512 if (attributes_file) {
513 elem = read_attr_from_file(attributes_file, 1);
516 elem->prev = attr_stack;
521 if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
522 elem = read_attr(GITATTRIBUTES_FILE, 1);
523 elem->origin = strdup("");
524 elem->prev = attr_stack;
529 elem = read_attr_from_file(git_path(INFOATTRIBUTES_FILE), 1);
531 elem = xcalloc(1, sizeof(*elem));
533 elem->prev = attr_stack;
537 static void prepare_attr_stack(const char *path, int dirlen)
539 struct attr_stack *elem, *info;
541 struct strbuf pathbuf;
543 strbuf_init(&pathbuf, dirlen+2+strlen(GITATTRIBUTES_FILE));
546 * At the bottom of the attribute stack is the built-in
547 * set of attribute definitions, followed by the contents
548 * of $(prefix)/etc/gitattributes and a file specified by
549 * core.attributesfile. Then, contents from
550 * .gitattribute files from directories closer to the
551 * root to the ones in deeper directories are pushed
552 * to the stack. Finally, at the very top of the stack
553 * we always keep the contents of $GIT_DIR/info/attributes.
555 * When checking, we use entries from near the top of the
556 * stack, preferring $GIT_DIR/info/attributes, then
557 * .gitattributes in deeper directories to shallower ones,
558 * and finally use the built-in set as the default.
561 bootstrap_attr_stack();
564 * Pop the "info" one that is always at the top of the stack.
567 attr_stack = info->prev;
570 * Pop the ones from directories that are not the prefix of
571 * the path we are checking. Break out of the loop when we see
572 * the root one (whose origin is an empty string "") or the builtin
573 * one (whose origin is NULL) without popping it.
575 while (attr_stack->origin) {
576 int namelen = strlen(attr_stack->origin);
579 if (namelen <= dirlen &&
580 !strncmp(elem->origin, path, namelen) &&
581 (!namelen || path[namelen] == '/'))
585 attr_stack = elem->prev;
586 free_attr_elem(elem);
590 * Read from parent directories and push them down
592 if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
594 * bootstrap_attr_stack() should have added, and the
595 * above loop should have stopped before popping, the
596 * root element whose attr_stack->origin is set to an
599 assert(attr_stack->origin);
603 len = strlen(attr_stack->origin);
606 strbuf_reset(&pathbuf);
607 strbuf_add(&pathbuf, path, dirlen);
608 strbuf_addch(&pathbuf, '/');
609 cp = strchr(pathbuf.buf + len + 1, '/');
610 strcpy(cp + 1, GITATTRIBUTES_FILE);
611 elem = read_attr(pathbuf.buf, 0);
613 elem->origin = strdup(pathbuf.buf);
614 elem->prev = attr_stack;
620 strbuf_release(&pathbuf);
623 * Finally push the "info" one at the top of the stack.
625 info->prev = attr_stack;
629 static int path_matches(const char *pathname, int pathlen,
631 const char *base, int baselen)
633 if (!strchr(pattern, '/')) {
635 const char *basename = strrchr(pathname, '/');
636 basename = basename ? basename + 1 : pathname;
637 return (fnmatch(pattern, basename, 0) == 0);
640 * match with FNM_PATHNAME; the pattern has base implicitly
645 if (pathlen < baselen ||
646 (baselen && pathname[baselen] != '/') ||
647 strncmp(pathname, base, baselen))
651 return fnmatch(pattern, pathname + baselen, FNM_PATHNAME) == 0;
654 static int macroexpand_one(int attr_nr, int rem);
656 static int fill_one(const char *what, struct match_attr *a, int rem)
658 struct git_attr_check *check = check_all_attr;
661 for (i = a->num_attr - 1; 0 < rem && 0 <= i; i--) {
662 struct git_attr *attr = a->state[i].attr;
663 const char **n = &(check[attr->attr_nr].value);
664 const char *v = a->state[i].setto;
666 if (*n == ATTR__UNKNOWN) {
668 a->is_macro ? a->u.attr->name : a->u.pattern,
672 rem = macroexpand_one(attr->attr_nr, rem);
678 static int fill(const char *path, int pathlen, struct attr_stack *stk, int rem)
681 const char *base = stk->origin ? stk->origin : "";
683 for (i = stk->num_matches - 1; 0 < rem && 0 <= i; i--) {
684 struct match_attr *a = stk->attrs[i];
687 if (path_matches(path, pathlen,
688 a->u.pattern, base, strlen(base)))
689 rem = fill_one("fill", a, rem);
694 static int macroexpand_one(int attr_nr, int rem)
696 struct attr_stack *stk;
697 struct match_attr *a = NULL;
700 if (check_all_attr[attr_nr].value != ATTR__TRUE)
703 for (stk = attr_stack; !a && stk; stk = stk->prev)
704 for (i = stk->num_matches - 1; !a && 0 <= i; i--) {
705 struct match_attr *ma = stk->attrs[i];
708 if (ma->u.attr->attr_nr == attr_nr)
713 rem = fill_one("expand", a, rem);
718 int git_checkattr(const char *path, int num, struct git_attr_check *check)
720 struct attr_stack *stk;
722 int dirlen, pathlen, i, rem;
724 bootstrap_attr_stack();
725 for (i = 0; i < attr_nr; i++)
726 check_all_attr[i].value = ATTR__UNKNOWN;
728 pathlen = strlen(path);
729 cp = strrchr(path, '/');
734 prepare_attr_stack(path, dirlen);
736 for (stk = attr_stack; 0 < rem && stk; stk = stk->prev)
737 rem = fill(path, pathlen, stk, rem);
739 for (i = 0; i < num; i++) {
740 const char *value = check_all_attr[check[i].attr->attr_nr].value;
741 if (value == ATTR__UNKNOWN)
743 check[i].value = value;
749 void git_attr_set_direction(enum git_attr_direction new, struct index_state *istate)
751 enum git_attr_direction old = direction;
753 if (is_bare_repository() && new != GIT_ATTR_INDEX)
754 die("BUG: non-INDEX attr direction in a bare repo");