Merge branch 'wk/man-deny-current-branch-is-default-these-days'
[git/gitweb.git] / attr.c
blob4657cc233c4aa7cff90e745a58ac7ad0a5fa8cd2
1 /*
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.
8 */
10 #define NO_THE_INDEX_COMPATIBILITY_MACROS
11 #include "cache.h"
12 #include "exec_cmd.h"
13 #include "attr.h"
14 #include "dir.h"
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. */
25 #define HASHSIZE 257
27 #ifndef DEBUG_ATTR
28 #define DEBUG_ATTR 0
29 #endif
31 struct git_attr {
32 struct git_attr *next;
33 unsigned h;
34 int attr_nr;
35 char name[FLEX_ARRAY];
37 static int attr_nr;
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)
44 return attr->name;
47 static unsigned hash_name(const char *name, int namelen)
49 unsigned val = 0, c;
51 while (namelen--) {
52 c = *name++;
53 val = ((val << 7) | (val >> 22)) ^ c;
55 return val;
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 == '-')
65 return -1;
66 while (namelen--) {
67 char ch = *name++;
68 if (! (ch == '-' || ch == '.' || ch == '_' ||
69 ('0' <= ch && ch <= '9') ||
70 ('a' <= ch && ch <= 'z') ||
71 ('A' <= ch && ch <= 'Z')) )
72 return -1;
74 return 0;
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;
81 struct git_attr *a;
83 for (a = git_attr_hash[pos]; a; a = a->next) {
84 if (a->h == hval &&
85 !memcmp(a->name, name, len) && !a->name[len])
86 return a;
89 if (invalid_attr_name(name, len))
90 return NULL;
92 a = xmalloc(sizeof(*a) + len + 1);
93 memcpy(a->name, name, len);
94 a->name[len] = 0;
95 a->h = hval;
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;
104 return a;
107 struct git_attr *git_attr(const char *name)
109 return git_attr_internal(name, strlen(name));
112 /* What does a matched pattern decide? */
113 struct attr_state {
114 struct git_attr *attr;
115 const char *setto;
118 struct pattern {
119 const char *pattern;
120 int patternlen;
121 int nowildcardlen;
122 int flags; /* EXC_FLAG_* */
126 * One rule, as from a .gitattributes file.
128 * If is_macro is true, then u.attr is a pointer to the git_attr being
129 * defined.
131 * If is_macro is false, then u.pattern points at the filename pattern
132 * to which the rule applies. (The memory pointed to is part of the
133 * memory block allocated for the match_attr instance.)
135 * In either case, num_attr is the number of attributes affected by
136 * this rule, and state is an array listing them. The attributes are
137 * listed as they appear in the file (macros unexpanded).
139 struct match_attr {
140 union {
141 struct pattern pat;
142 struct git_attr *attr;
143 } u;
144 char is_macro;
145 unsigned num_attr;
146 struct attr_state state[FLEX_ARRAY];
149 static const char blank[] = " \t\r\n";
152 * Parse a whitespace-delimited attribute state (i.e., "attr",
153 * "-attr", "!attr", or "attr=value") from the string starting at src.
154 * If e is not NULL, write the results to *e. Return a pointer to the
155 * remainder of the string (with leading whitespace removed), or NULL
156 * if there was an error.
158 static const char *parse_attr(const char *src, int lineno, const char *cp,
159 struct attr_state *e)
161 const char *ep, *equals;
162 int len;
164 ep = cp + strcspn(cp, blank);
165 equals = strchr(cp, '=');
166 if (equals && ep < equals)
167 equals = NULL;
168 if (equals)
169 len = equals - cp;
170 else
171 len = ep - cp;
172 if (!e) {
173 if (*cp == '-' || *cp == '!') {
174 cp++;
175 len--;
177 if (invalid_attr_name(cp, len)) {
178 fprintf(stderr,
179 "%.*s is not a valid attribute name: %s:%d\n",
180 len, cp, src, lineno);
181 return NULL;
183 } else {
184 if (*cp == '-' || *cp == '!') {
185 e->setto = (*cp == '-') ? ATTR__FALSE : ATTR__UNSET;
186 cp++;
187 len--;
189 else if (!equals)
190 e->setto = ATTR__TRUE;
191 else {
192 e->setto = xmemdupz(equals + 1, ep - equals - 1);
194 e->attr = git_attr_internal(cp, len);
196 return ep + strspn(ep, blank);
199 static struct match_attr *parse_attr_line(const char *line, const char *src,
200 int lineno, int macro_ok)
202 int namelen;
203 int num_attr, i;
204 const char *cp, *name, *states;
205 struct match_attr *res = NULL;
206 int is_macro;
208 cp = line + strspn(line, blank);
209 if (!*cp || *cp == '#')
210 return NULL;
211 name = cp;
212 namelen = strcspn(name, blank);
213 if (strlen(ATTRIBUTE_MACRO_PREFIX) < namelen &&
214 !prefixcmp(name, ATTRIBUTE_MACRO_PREFIX)) {
215 if (!macro_ok) {
216 fprintf(stderr, "%s not allowed: %s:%d\n",
217 name, src, lineno);
218 return NULL;
220 is_macro = 1;
221 name += strlen(ATTRIBUTE_MACRO_PREFIX);
222 name += strspn(name, blank);
223 namelen = strcspn(name, blank);
224 if (invalid_attr_name(name, namelen)) {
225 fprintf(stderr,
226 "%.*s is not a valid attribute name: %s:%d\n",
227 namelen, name, src, lineno);
228 return NULL;
231 else
232 is_macro = 0;
234 states = name + namelen;
235 states += strspn(states, blank);
237 /* First pass to count the attr_states */
238 for (cp = states, num_attr = 0; *cp; num_attr++) {
239 cp = parse_attr(src, lineno, cp, NULL);
240 if (!cp)
241 return NULL;
244 res = xcalloc(1,
245 sizeof(*res) +
246 sizeof(struct attr_state) * num_attr +
247 (is_macro ? 0 : namelen + 1));
248 if (is_macro)
249 res->u.attr = git_attr_internal(name, namelen);
250 else {
251 char *p = (char *)&(res->state[num_attr]);
252 memcpy(p, name, namelen);
253 res->u.pat.pattern = p;
254 parse_exclude_pattern(&res->u.pat.pattern,
255 &res->u.pat.patternlen,
256 &res->u.pat.flags,
257 &res->u.pat.nowildcardlen);
258 if (res->u.pat.flags & EXC_FLAG_NEGATIVE)
259 die(_("Negative patterns are forbidden in git attributes\n"
260 "Use '\\!' for literal leading exclamation."));
262 res->is_macro = is_macro;
263 res->num_attr = num_attr;
265 /* Second pass to fill the attr_states */
266 for (cp = states, i = 0; *cp; i++) {
267 cp = parse_attr(src, lineno, cp, &(res->state[i]));
270 return res;
274 * Like info/exclude and .gitignore, the attribute information can
275 * come from many places.
277 * (1) .gitattribute file of the same directory;
278 * (2) .gitattribute file of the parent directory if (1) does not have
279 * any match; this goes recursively upwards, just like .gitignore.
280 * (3) $GIT_DIR/info/attributes, which overrides both of the above.
282 * In the same file, later entries override the earlier match, so in the
283 * global list, we would have entries from info/attributes the earliest
284 * (reading the file from top to bottom), .gitattribute of the root
285 * directory (again, reading the file from top to bottom) down to the
286 * current directory, and then scan the list backwards to find the first match.
287 * This is exactly the same as what is_excluded() does in dir.c to deal with
288 * .gitignore
291 static struct attr_stack {
292 struct attr_stack *prev;
293 char *origin;
294 size_t originlen;
295 unsigned num_matches;
296 unsigned alloc;
297 struct match_attr **attrs;
298 } *attr_stack;
300 static void free_attr_elem(struct attr_stack *e)
302 int i;
303 free(e->origin);
304 for (i = 0; i < e->num_matches; i++) {
305 struct match_attr *a = e->attrs[i];
306 int j;
307 for (j = 0; j < a->num_attr; j++) {
308 const char *setto = a->state[j].setto;
309 if (setto == ATTR__TRUE ||
310 setto == ATTR__FALSE ||
311 setto == ATTR__UNSET ||
312 setto == ATTR__UNKNOWN)
314 else
315 free((char *) setto);
317 free(a);
319 free(e->attrs);
320 free(e);
323 static const char *builtin_attr[] = {
324 "[attr]binary -diff -merge -text",
325 NULL,
328 static void handle_attr_line(struct attr_stack *res,
329 const char *line,
330 const char *src,
331 int lineno,
332 int macro_ok)
334 struct match_attr *a;
336 a = parse_attr_line(line, src, lineno, macro_ok);
337 if (!a)
338 return;
339 if (res->alloc <= res->num_matches) {
340 res->alloc = alloc_nr(res->num_matches);
341 res->attrs = xrealloc(res->attrs,
342 sizeof(struct match_attr *) *
343 res->alloc);
345 res->attrs[res->num_matches++] = a;
348 static struct attr_stack *read_attr_from_array(const char **list)
350 struct attr_stack *res;
351 const char *line;
352 int lineno = 0;
354 res = xcalloc(1, sizeof(*res));
355 while ((line = *(list++)) != NULL)
356 handle_attr_line(res, line, "[builtin]", ++lineno, 1);
357 return res;
360 static enum git_attr_direction direction;
361 static struct index_state *use_index;
363 static struct attr_stack *read_attr_from_file(const char *path, int macro_ok)
365 FILE *fp = fopen(path, "r");
366 struct attr_stack *res;
367 char buf[2048];
368 int lineno = 0;
370 if (!fp) {
371 if (errno != ENOENT && errno != ENOTDIR)
372 warn_on_inaccessible(path);
373 return NULL;
375 res = xcalloc(1, sizeof(*res));
376 while (fgets(buf, sizeof(buf), fp))
377 handle_attr_line(res, buf, path, ++lineno, macro_ok);
378 fclose(fp);
379 return res;
382 static void *read_index_data(const char *path)
384 int pos, len;
385 unsigned long sz;
386 enum object_type type;
387 void *data;
388 struct index_state *istate = use_index ? use_index : &the_index;
390 len = strlen(path);
391 pos = index_name_pos(istate, path, len);
392 if (pos < 0) {
394 * We might be in the middle of a merge, in which
395 * case we would read stage #2 (ours).
397 int i;
398 for (i = -pos - 1;
399 (pos < 0 && i < istate->cache_nr &&
400 !strcmp(istate->cache[i]->name, path));
401 i++)
402 if (ce_stage(istate->cache[i]) == 2)
403 pos = i;
405 if (pos < 0)
406 return NULL;
407 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
408 if (!data || type != OBJ_BLOB) {
409 free(data);
410 return NULL;
412 return data;
415 static struct attr_stack *read_attr_from_index(const char *path, int macro_ok)
417 struct attr_stack *res;
418 char *buf, *sp;
419 int lineno = 0;
421 buf = read_index_data(path);
422 if (!buf)
423 return NULL;
425 res = xcalloc(1, sizeof(*res));
426 for (sp = buf; *sp; ) {
427 char *ep;
428 int more;
429 for (ep = sp; *ep && *ep != '\n'; ep++)
431 more = (*ep == '\n');
432 *ep = '\0';
433 handle_attr_line(res, sp, path, ++lineno, macro_ok);
434 sp = ep + more;
436 free(buf);
437 return res;
440 static struct attr_stack *read_attr(const char *path, int macro_ok)
442 struct attr_stack *res;
444 if (direction == GIT_ATTR_CHECKOUT) {
445 res = read_attr_from_index(path, macro_ok);
446 if (!res)
447 res = read_attr_from_file(path, macro_ok);
449 else if (direction == GIT_ATTR_CHECKIN) {
450 res = read_attr_from_file(path, macro_ok);
451 if (!res)
453 * There is no checked out .gitattributes file there, but
454 * we might have it in the index. We allow operation in a
455 * sparsely checked out work tree, so read from it.
457 res = read_attr_from_index(path, macro_ok);
459 else
460 res = read_attr_from_index(path, macro_ok);
461 if (!res)
462 res = xcalloc(1, sizeof(*res));
463 return res;
466 #if DEBUG_ATTR
467 static void debug_info(const char *what, struct attr_stack *elem)
469 fprintf(stderr, "%s: %s\n", what, elem->origin ? elem->origin : "()");
471 static void debug_set(const char *what, const char *match, struct git_attr *attr, const void *v)
473 const char *value = v;
475 if (ATTR_TRUE(value))
476 value = "set";
477 else if (ATTR_FALSE(value))
478 value = "unset";
479 else if (ATTR_UNSET(value))
480 value = "unspecified";
482 fprintf(stderr, "%s: %s => %s (%s)\n",
483 what, attr->name, (char *) value, match);
485 #define debug_push(a) debug_info("push", (a))
486 #define debug_pop(a) debug_info("pop", (a))
487 #else
488 #define debug_push(a) do { ; } while (0)
489 #define debug_pop(a) do { ; } while (0)
490 #define debug_set(a,b,c,d) do { ; } while (0)
491 #endif
493 static void drop_attr_stack(void)
495 while (attr_stack) {
496 struct attr_stack *elem = attr_stack;
497 attr_stack = elem->prev;
498 free_attr_elem(elem);
502 static const char *git_etc_gitattributes(void)
504 static const char *system_wide;
505 if (!system_wide)
506 system_wide = system_path(ETC_GITATTRIBUTES);
507 return system_wide;
510 static int git_attr_system(void)
512 return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
515 static void bootstrap_attr_stack(void)
517 struct attr_stack *elem;
518 char *xdg_attributes_file;
520 if (attr_stack)
521 return;
523 elem = read_attr_from_array(builtin_attr);
524 elem->origin = NULL;
525 elem->prev = attr_stack;
526 attr_stack = elem;
528 if (git_attr_system()) {
529 elem = read_attr_from_file(git_etc_gitattributes(), 1);
530 if (elem) {
531 elem->origin = NULL;
532 elem->prev = attr_stack;
533 attr_stack = elem;
537 if (!git_attributes_file) {
538 home_config_paths(NULL, &xdg_attributes_file, "attributes");
539 git_attributes_file = xdg_attributes_file;
541 if (git_attributes_file) {
542 elem = read_attr_from_file(git_attributes_file, 1);
543 if (elem) {
544 elem->origin = NULL;
545 elem->prev = attr_stack;
546 attr_stack = elem;
550 if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
551 elem = read_attr(GITATTRIBUTES_FILE, 1);
552 elem->origin = xstrdup("");
553 elem->originlen = 0;
554 elem->prev = attr_stack;
555 attr_stack = elem;
556 debug_push(elem);
559 elem = read_attr_from_file(git_path(INFOATTRIBUTES_FILE), 1);
560 if (!elem)
561 elem = xcalloc(1, sizeof(*elem));
562 elem->origin = NULL;
563 elem->prev = attr_stack;
564 attr_stack = elem;
567 static void prepare_attr_stack(const char *path, int dirlen)
569 struct attr_stack *elem, *info;
570 int len;
571 const char *cp;
574 * At the bottom of the attribute stack is the built-in
575 * set of attribute definitions, followed by the contents
576 * of $(prefix)/etc/gitattributes and a file specified by
577 * core.attributesfile. Then, contents from
578 * .gitattribute files from directories closer to the
579 * root to the ones in deeper directories are pushed
580 * to the stack. Finally, at the very top of the stack
581 * we always keep the contents of $GIT_DIR/info/attributes.
583 * When checking, we use entries from near the top of the
584 * stack, preferring $GIT_DIR/info/attributes, then
585 * .gitattributes in deeper directories to shallower ones,
586 * and finally use the built-in set as the default.
588 bootstrap_attr_stack();
591 * Pop the "info" one that is always at the top of the stack.
593 info = attr_stack;
594 attr_stack = info->prev;
597 * Pop the ones from directories that are not the prefix of
598 * the path we are checking. Break out of the loop when we see
599 * the root one (whose origin is an empty string "") or the builtin
600 * one (whose origin is NULL) without popping it.
602 while (attr_stack->origin) {
603 int namelen = strlen(attr_stack->origin);
605 elem = attr_stack;
606 if (namelen <= dirlen &&
607 !strncmp(elem->origin, path, namelen) &&
608 (!namelen || path[namelen] == '/'))
609 break;
611 debug_pop(elem);
612 attr_stack = elem->prev;
613 free_attr_elem(elem);
617 * Read from parent directories and push them down
619 if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
621 * bootstrap_attr_stack() should have added, and the
622 * above loop should have stopped before popping, the
623 * root element whose attr_stack->origin is set to an
624 * empty string.
626 struct strbuf pathbuf = STRBUF_INIT;
628 assert(attr_stack->origin);
629 while (1) {
630 len = strlen(attr_stack->origin);
631 if (dirlen <= len)
632 break;
633 cp = memchr(path + len + 1, '/', dirlen - len - 1);
634 if (!cp)
635 cp = path + dirlen;
636 strbuf_add(&pathbuf, path, cp - path);
637 strbuf_addch(&pathbuf, '/');
638 strbuf_addstr(&pathbuf, GITATTRIBUTES_FILE);
639 elem = read_attr(pathbuf.buf, 0);
640 strbuf_setlen(&pathbuf, cp - path);
641 elem->origin = strbuf_detach(&pathbuf, &elem->originlen);
642 elem->prev = attr_stack;
643 attr_stack = elem;
644 debug_push(elem);
647 strbuf_release(&pathbuf);
651 * Finally push the "info" one at the top of the stack.
653 info->prev = attr_stack;
654 attr_stack = info;
657 static int path_matches(const char *pathname, int pathlen,
658 const char *basename,
659 const struct pattern *pat,
660 const char *base, int baselen)
662 const char *pattern = pat->pattern;
663 int prefix = pat->nowildcardlen;
665 if ((pat->flags & EXC_FLAG_MUSTBEDIR) &&
666 ((!pathlen) || (pathname[pathlen-1] != '/')))
667 return 0;
669 if (pat->flags & EXC_FLAG_NODIR) {
670 return match_basename(basename,
671 pathlen - (basename - pathname),
672 pattern, prefix,
673 pat->patternlen, pat->flags);
675 return match_pathname(pathname, pathlen,
676 base, baselen,
677 pattern, prefix, pat->patternlen, pat->flags);
680 static int macroexpand_one(int attr_nr, int rem);
682 static int fill_one(const char *what, struct match_attr *a, int rem)
684 struct git_attr_check *check = check_all_attr;
685 int i;
687 for (i = a->num_attr - 1; 0 < rem && 0 <= i; i--) {
688 struct git_attr *attr = a->state[i].attr;
689 const char **n = &(check[attr->attr_nr].value);
690 const char *v = a->state[i].setto;
692 if (*n == ATTR__UNKNOWN) {
693 debug_set(what,
694 a->is_macro ? a->u.attr->name : a->u.pat.pattern,
695 attr, v);
696 *n = v;
697 rem--;
698 rem = macroexpand_one(attr->attr_nr, rem);
701 return rem;
704 static int fill(const char *path, int pathlen, const char *basename,
705 struct attr_stack *stk, int rem)
707 int i;
708 const char *base = stk->origin ? stk->origin : "";
710 for (i = stk->num_matches - 1; 0 < rem && 0 <= i; i--) {
711 struct match_attr *a = stk->attrs[i];
712 if (a->is_macro)
713 continue;
714 if (path_matches(path, pathlen, basename,
715 &a->u.pat, base, stk->originlen))
716 rem = fill_one("fill", a, rem);
718 return rem;
721 static int macroexpand_one(int attr_nr, int rem)
723 struct attr_stack *stk;
724 struct match_attr *a = NULL;
725 int i;
727 if (check_all_attr[attr_nr].value != ATTR__TRUE)
728 return rem;
730 for (stk = attr_stack; !a && stk; stk = stk->prev)
731 for (i = stk->num_matches - 1; !a && 0 <= i; i--) {
732 struct match_attr *ma = stk->attrs[i];
733 if (!ma->is_macro)
734 continue;
735 if (ma->u.attr->attr_nr == attr_nr)
736 a = ma;
739 if (a)
740 rem = fill_one("expand", a, rem);
742 return rem;
746 * Collect all attributes for path into the array pointed to by
747 * check_all_attr.
749 static void collect_all_attrs(const char *path)
751 struct attr_stack *stk;
752 int i, pathlen, rem, dirlen;
753 const char *basename, *cp, *last_slash = NULL;
755 for (cp = path; *cp; cp++) {
756 if (*cp == '/' && cp[1])
757 last_slash = cp;
759 pathlen = cp - path;
760 if (last_slash) {
761 basename = last_slash + 1;
762 dirlen = last_slash - path;
763 } else {
764 basename = path;
765 dirlen = 0;
768 prepare_attr_stack(path, dirlen);
769 for (i = 0; i < attr_nr; i++)
770 check_all_attr[i].value = ATTR__UNKNOWN;
772 rem = attr_nr;
773 for (stk = attr_stack; 0 < rem && stk; stk = stk->prev)
774 rem = fill(path, pathlen, basename, stk, rem);
777 int git_check_attr(const char *path, int num, struct git_attr_check *check)
779 int i;
781 collect_all_attrs(path);
783 for (i = 0; i < num; i++) {
784 const char *value = check_all_attr[check[i].attr->attr_nr].value;
785 if (value == ATTR__UNKNOWN)
786 value = ATTR__UNSET;
787 check[i].value = value;
790 return 0;
793 int git_all_attrs(const char *path, int *num, struct git_attr_check **check)
795 int i, count, j;
797 collect_all_attrs(path);
799 /* Count the number of attributes that are set. */
800 count = 0;
801 for (i = 0; i < attr_nr; i++) {
802 const char *value = check_all_attr[i].value;
803 if (value != ATTR__UNSET && value != ATTR__UNKNOWN)
804 ++count;
806 *num = count;
807 *check = xmalloc(sizeof(**check) * count);
808 j = 0;
809 for (i = 0; i < attr_nr; i++) {
810 const char *value = check_all_attr[i].value;
811 if (value != ATTR__UNSET && value != ATTR__UNKNOWN) {
812 (*check)[j].attr = check_all_attr[i].attr;
813 (*check)[j].value = value;
814 ++j;
818 return 0;
821 void git_attr_set_direction(enum git_attr_direction new, struct index_state *istate)
823 enum git_attr_direction old = direction;
825 if (is_bare_repository() && new != GIT_ATTR_INDEX)
826 die("BUG: non-INDEX attr direction in a bare repo");
828 direction = new;
829 if (new != old)
830 drop_attr_stack();
831 use_index = istate;