msysGit-based Git for Windows 1.x was superseded by Git for Windows 2.x
[git/mingw/4msysgit.git] / attr.c
blob734222dc45c588736f963dea7907258e76024415
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 starts_with(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 warning(_("Negative patterns are ignored in git attributes\n"
260 "Use '\\!' for literal leading exclamation."));
261 return NULL;
264 res->is_macro = is_macro;
265 res->num_attr = num_attr;
267 /* Second pass to fill the attr_states */
268 for (cp = states, i = 0; *cp; i++) {
269 cp = parse_attr(src, lineno, cp, &(res->state[i]));
272 return res;
276 * Like info/exclude and .gitignore, the attribute information can
277 * come from many places.
279 * (1) .gitattribute file of the same directory;
280 * (2) .gitattribute file of the parent directory if (1) does not have
281 * any match; this goes recursively upwards, just like .gitignore.
282 * (3) $GIT_DIR/info/attributes, which overrides both of the above.
284 * In the same file, later entries override the earlier match, so in the
285 * global list, we would have entries from info/attributes the earliest
286 * (reading the file from top to bottom), .gitattribute of the root
287 * directory (again, reading the file from top to bottom) down to the
288 * current directory, and then scan the list backwards to find the first match.
289 * This is exactly the same as what is_excluded() does in dir.c to deal with
290 * .gitignore
293 static struct attr_stack {
294 struct attr_stack *prev;
295 char *origin;
296 size_t originlen;
297 unsigned num_matches;
298 unsigned alloc;
299 struct match_attr **attrs;
300 } *attr_stack;
302 static void free_attr_elem(struct attr_stack *e)
304 int i;
305 free(e->origin);
306 for (i = 0; i < e->num_matches; i++) {
307 struct match_attr *a = e->attrs[i];
308 int j;
309 for (j = 0; j < a->num_attr; j++) {
310 const char *setto = a->state[j].setto;
311 if (setto == ATTR__TRUE ||
312 setto == ATTR__FALSE ||
313 setto == ATTR__UNSET ||
314 setto == ATTR__UNKNOWN)
316 else
317 free((char *) setto);
319 free(a);
321 free(e->attrs);
322 free(e);
325 static const char *builtin_attr[] = {
326 "[attr]binary -diff -merge -text",
327 NULL,
330 static void handle_attr_line(struct attr_stack *res,
331 const char *line,
332 const char *src,
333 int lineno,
334 int macro_ok)
336 struct match_attr *a;
338 a = parse_attr_line(line, src, lineno, macro_ok);
339 if (!a)
340 return;
341 ALLOC_GROW(res->attrs, res->num_matches + 1, res->alloc);
342 res->attrs[res->num_matches++] = a;
345 static struct attr_stack *read_attr_from_array(const char **list)
347 struct attr_stack *res;
348 const char *line;
349 int lineno = 0;
351 res = xcalloc(1, sizeof(*res));
352 while ((line = *(list++)) != NULL)
353 handle_attr_line(res, line, "[builtin]", ++lineno, 1);
354 return res;
357 static enum git_attr_direction direction;
358 static struct index_state *use_index;
360 static struct attr_stack *read_attr_from_file(const char *path, int macro_ok)
362 FILE *fp = fopen(path, "r");
363 struct attr_stack *res;
364 char buf[2048];
365 int lineno = 0;
367 if (!fp) {
368 if (errno != ENOENT && errno != ENOTDIR)
369 warn_on_inaccessible(path);
370 return NULL;
372 res = xcalloc(1, sizeof(*res));
373 while (fgets(buf, sizeof(buf), fp))
374 handle_attr_line(res, buf, path, ++lineno, macro_ok);
375 fclose(fp);
376 return res;
379 static struct attr_stack *read_attr_from_index(const char *path, int macro_ok)
381 struct attr_stack *res;
382 char *buf, *sp;
383 int lineno = 0;
385 buf = read_blob_data_from_index(use_index ? use_index : &the_index, path, NULL);
386 if (!buf)
387 return NULL;
389 res = xcalloc(1, sizeof(*res));
390 for (sp = buf; *sp; ) {
391 char *ep;
392 int more;
393 for (ep = sp; *ep && *ep != '\n'; ep++)
395 more = (*ep == '\n');
396 *ep = '\0';
397 handle_attr_line(res, sp, path, ++lineno, macro_ok);
398 sp = ep + more;
400 free(buf);
401 return res;
404 static struct attr_stack *read_attr(const char *path, int macro_ok)
406 struct attr_stack *res;
408 if (direction == GIT_ATTR_CHECKOUT) {
409 res = read_attr_from_index(path, macro_ok);
410 if (!res)
411 res = read_attr_from_file(path, macro_ok);
413 else if (direction == GIT_ATTR_CHECKIN) {
414 res = read_attr_from_file(path, macro_ok);
415 if (!res)
417 * There is no checked out .gitattributes file there, but
418 * we might have it in the index. We allow operation in a
419 * sparsely checked out work tree, so read from it.
421 res = read_attr_from_index(path, macro_ok);
423 else
424 res = read_attr_from_index(path, macro_ok);
425 if (!res)
426 res = xcalloc(1, sizeof(*res));
427 return res;
430 #if DEBUG_ATTR
431 static void debug_info(const char *what, struct attr_stack *elem)
433 fprintf(stderr, "%s: %s\n", what, elem->origin ? elem->origin : "()");
435 static void debug_set(const char *what, const char *match, struct git_attr *attr, const void *v)
437 const char *value = v;
439 if (ATTR_TRUE(value))
440 value = "set";
441 else if (ATTR_FALSE(value))
442 value = "unset";
443 else if (ATTR_UNSET(value))
444 value = "unspecified";
446 fprintf(stderr, "%s: %s => %s (%s)\n",
447 what, attr->name, (char *) value, match);
449 #define debug_push(a) debug_info("push", (a))
450 #define debug_pop(a) debug_info("pop", (a))
451 #else
452 #define debug_push(a) do { ; } while (0)
453 #define debug_pop(a) do { ; } while (0)
454 #define debug_set(a,b,c,d) do { ; } while (0)
455 #endif
457 static void drop_attr_stack(void)
459 while (attr_stack) {
460 struct attr_stack *elem = attr_stack;
461 attr_stack = elem->prev;
462 free_attr_elem(elem);
466 static const char *git_etc_gitattributes(void)
468 static const char *system_wide;
469 if (!system_wide)
470 system_wide = system_path(ETC_GITATTRIBUTES);
471 return system_wide;
474 static int git_attr_system(void)
476 return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
479 static void bootstrap_attr_stack(void)
481 struct attr_stack *elem;
482 char *xdg_attributes_file;
484 if (attr_stack)
485 return;
487 elem = read_attr_from_array(builtin_attr);
488 elem->origin = NULL;
489 elem->prev = attr_stack;
490 attr_stack = elem;
492 if (git_attr_system()) {
493 elem = read_attr_from_file(git_etc_gitattributes(), 1);
494 if (elem) {
495 elem->origin = NULL;
496 elem->prev = attr_stack;
497 attr_stack = elem;
501 if (!git_attributes_file) {
502 home_config_paths(NULL, &xdg_attributes_file, "attributes");
503 git_attributes_file = xdg_attributes_file;
505 if (git_attributes_file) {
506 elem = read_attr_from_file(git_attributes_file, 1);
507 if (elem) {
508 elem->origin = NULL;
509 elem->prev = attr_stack;
510 attr_stack = elem;
514 if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
515 elem = read_attr(GITATTRIBUTES_FILE, 1);
516 elem->origin = xstrdup("");
517 elem->originlen = 0;
518 elem->prev = attr_stack;
519 attr_stack = elem;
520 debug_push(elem);
523 elem = read_attr_from_file(git_path(INFOATTRIBUTES_FILE), 1);
524 if (!elem)
525 elem = xcalloc(1, sizeof(*elem));
526 elem->origin = NULL;
527 elem->prev = attr_stack;
528 attr_stack = elem;
531 static void prepare_attr_stack(const char *path, int dirlen)
533 struct attr_stack *elem, *info;
534 int len;
535 const char *cp;
538 * At the bottom of the attribute stack is the built-in
539 * set of attribute definitions, followed by the contents
540 * of $(prefix)/etc/gitattributes and a file specified by
541 * core.attributesfile. Then, contents from
542 * .gitattribute files from directories closer to the
543 * root to the ones in deeper directories are pushed
544 * to the stack. Finally, at the very top of the stack
545 * we always keep the contents of $GIT_DIR/info/attributes.
547 * When checking, we use entries from near the top of the
548 * stack, preferring $GIT_DIR/info/attributes, then
549 * .gitattributes in deeper directories to shallower ones,
550 * and finally use the built-in set as the default.
552 bootstrap_attr_stack();
555 * Pop the "info" one that is always at the top of the stack.
557 info = attr_stack;
558 attr_stack = info->prev;
561 * Pop the ones from directories that are not the prefix of
562 * the path we are checking. Break out of the loop when we see
563 * the root one (whose origin is an empty string "") or the builtin
564 * one (whose origin is NULL) without popping it.
566 while (attr_stack->origin) {
567 int namelen = strlen(attr_stack->origin);
569 elem = attr_stack;
570 if (namelen <= dirlen &&
571 !strncmp(elem->origin, path, namelen) &&
572 (!namelen || path[namelen] == '/'))
573 break;
575 debug_pop(elem);
576 attr_stack = elem->prev;
577 free_attr_elem(elem);
581 * Read from parent directories and push them down
583 if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
585 * bootstrap_attr_stack() should have added, and the
586 * above loop should have stopped before popping, the
587 * root element whose attr_stack->origin is set to an
588 * empty string.
590 struct strbuf pathbuf = STRBUF_INIT;
592 assert(attr_stack->origin);
593 while (1) {
594 len = strlen(attr_stack->origin);
595 if (dirlen <= len)
596 break;
597 cp = memchr(path + len + 1, '/', dirlen - len - 1);
598 if (!cp)
599 cp = path + dirlen;
600 strbuf_add(&pathbuf, path, cp - path);
601 strbuf_addch(&pathbuf, '/');
602 strbuf_addstr(&pathbuf, GITATTRIBUTES_FILE);
603 elem = read_attr(pathbuf.buf, 0);
604 strbuf_setlen(&pathbuf, cp - path);
605 elem->origin = strbuf_detach(&pathbuf, &elem->originlen);
606 elem->prev = attr_stack;
607 attr_stack = elem;
608 debug_push(elem);
611 strbuf_release(&pathbuf);
615 * Finally push the "info" one at the top of the stack.
617 info->prev = attr_stack;
618 attr_stack = info;
621 static int path_matches(const char *pathname, int pathlen,
622 int basename_offset,
623 const struct pattern *pat,
624 const char *base, int baselen)
626 const char *pattern = pat->pattern;
627 int prefix = pat->nowildcardlen;
628 int isdir = (pathlen && pathname[pathlen - 1] == '/');
630 if ((pat->flags & EXC_FLAG_MUSTBEDIR) && !isdir)
631 return 0;
633 if (pat->flags & EXC_FLAG_NODIR) {
634 return match_basename(pathname + basename_offset,
635 pathlen - basename_offset - isdir,
636 pattern, prefix,
637 pat->patternlen, pat->flags);
639 return match_pathname(pathname, pathlen - isdir,
640 base, baselen,
641 pattern, prefix, pat->patternlen, pat->flags);
644 static int macroexpand_one(int attr_nr, int rem);
646 static int fill_one(const char *what, struct match_attr *a, int rem)
648 struct git_attr_check *check = check_all_attr;
649 int i;
651 for (i = a->num_attr - 1; 0 < rem && 0 <= i; i--) {
652 struct git_attr *attr = a->state[i].attr;
653 const char **n = &(check[attr->attr_nr].value);
654 const char *v = a->state[i].setto;
656 if (*n == ATTR__UNKNOWN) {
657 debug_set(what,
658 a->is_macro ? a->u.attr->name : a->u.pat.pattern,
659 attr, v);
660 *n = v;
661 rem--;
662 rem = macroexpand_one(attr->attr_nr, rem);
665 return rem;
668 static int fill(const char *path, int pathlen, int basename_offset,
669 struct attr_stack *stk, int rem)
671 int i;
672 const char *base = stk->origin ? stk->origin : "";
674 for (i = stk->num_matches - 1; 0 < rem && 0 <= i; i--) {
675 struct match_attr *a = stk->attrs[i];
676 if (a->is_macro)
677 continue;
678 if (path_matches(path, pathlen, basename_offset,
679 &a->u.pat, base, stk->originlen))
680 rem = fill_one("fill", a, rem);
682 return rem;
685 static int macroexpand_one(int attr_nr, int rem)
687 struct attr_stack *stk;
688 struct match_attr *a = NULL;
689 int i;
691 if (check_all_attr[attr_nr].value != ATTR__TRUE)
692 return rem;
694 for (stk = attr_stack; !a && stk; stk = stk->prev)
695 for (i = stk->num_matches - 1; !a && 0 <= i; i--) {
696 struct match_attr *ma = stk->attrs[i];
697 if (!ma->is_macro)
698 continue;
699 if (ma->u.attr->attr_nr == attr_nr)
700 a = ma;
703 if (a)
704 rem = fill_one("expand", a, rem);
706 return rem;
710 * Collect all attributes for path into the array pointed to by
711 * check_all_attr.
713 static void collect_all_attrs(const char *path)
715 struct attr_stack *stk;
716 int i, pathlen, rem, dirlen;
717 const char *cp, *last_slash = NULL;
718 int basename_offset;
720 for (cp = path; *cp; cp++) {
721 if (*cp == '/' && cp[1])
722 last_slash = cp;
724 pathlen = cp - path;
725 if (last_slash) {
726 basename_offset = last_slash + 1 - path;
727 dirlen = last_slash - path;
728 } else {
729 basename_offset = 0;
730 dirlen = 0;
733 prepare_attr_stack(path, dirlen);
734 for (i = 0; i < attr_nr; i++)
735 check_all_attr[i].value = ATTR__UNKNOWN;
737 rem = attr_nr;
738 for (stk = attr_stack; 0 < rem && stk; stk = stk->prev)
739 rem = fill(path, pathlen, basename_offset, stk, rem);
742 int git_check_attr(const char *path, int num, struct git_attr_check *check)
744 int i;
746 collect_all_attrs(path);
748 for (i = 0; i < num; i++) {
749 const char *value = check_all_attr[check[i].attr->attr_nr].value;
750 if (value == ATTR__UNKNOWN)
751 value = ATTR__UNSET;
752 check[i].value = value;
755 return 0;
758 int git_all_attrs(const char *path, int *num, struct git_attr_check **check)
760 int i, count, j;
762 collect_all_attrs(path);
764 /* Count the number of attributes that are set. */
765 count = 0;
766 for (i = 0; i < attr_nr; i++) {
767 const char *value = check_all_attr[i].value;
768 if (value != ATTR__UNSET && value != ATTR__UNKNOWN)
769 ++count;
771 *num = count;
772 *check = xmalloc(sizeof(**check) * count);
773 j = 0;
774 for (i = 0; i < attr_nr; i++) {
775 const char *value = check_all_attr[i].value;
776 if (value != ATTR__UNSET && value != ATTR__UNKNOWN) {
777 (*check)[j].attr = check_all_attr[i].attr;
778 (*check)[j].value = value;
779 ++j;
783 return 0;
786 void git_attr_set_direction(enum git_attr_direction new, struct index_state *istate)
788 enum git_attr_direction old = direction;
790 if (is_bare_repository() && new != GIT_ATTR_INDEX)
791 die("BUG: non-INDEX attr direction in a bare repo");
793 direction = new;
794 if (new != old)
795 drop_attr_stack();
796 use_index = istate;