Code

Merge branch 'jn/gitweb-hilite-regions'
[git.git] / attr.c
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.
5  *
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];
36 };
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)
43 {
44         return attr->name;
45 }
47 static unsigned hash_name(const char *name, int namelen)
48 {
49         unsigned val = 0, c;
51         while (namelen--) {
52                 c = *name++;
53                 val = ((val << 7) | (val >> 22)) ^ c;
54         }
55         return val;
56 }
58 static int invalid_attr_name(const char *name, int namelen)
59 {
60         /*
61          * Attribute name cannot begin with '-' and must consist of
62          * characters from [-A-Za-z0-9_.].
63          */
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;
73         }
74         return 0;
75 }
77 static struct git_attr *git_attr_internal(const char *name, int len)
78 {
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;
87         }
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;
116 };
118 /*
119  * One rule, as from a .gitattributes file.
120  *
121  * If is_macro is true, then u.attr is a pointer to the git_attr being
122  * defined.
123  *
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.)
127  *
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).
131  */
132 struct match_attr {
133         union {
134                 char *pattern;
135                 struct git_attr *attr;
136         } u;
137         char is_macro;
138         unsigned num_attr;
139         struct attr_state state[FLEX_ARRAY];
140 };
142 static const char blank[] = " \t\r\n";
144 /*
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.
150  */
151 static const char *parse_attr(const char *src, int lineno, const char *cp,
152                               struct attr_state *e)
154         const char *ep, *equals;
155         int len;
157         ep = cp + strcspn(cp, blank);
158         equals = strchr(cp, '=');
159         if (equals && ep < equals)
160                 equals = NULL;
161         if (equals)
162                 len = equals - cp;
163         else
164                 len = ep - cp;
165         if (!e) {
166                 if (*cp == '-' || *cp == '!') {
167                         cp++;
168                         len--;
169                 }
170                 if (invalid_attr_name(cp, len)) {
171                         fprintf(stderr,
172                                 "%.*s is not a valid attribute name: %s:%d\n",
173                                 len, cp, src, lineno);
174                         return NULL;
175                 }
176         } else {
177                 if (*cp == '-' || *cp == '!') {
178                         e->setto = (*cp == '-') ? ATTR__FALSE : ATTR__UNSET;
179                         cp++;
180                         len--;
181                 }
182                 else if (!equals)
183                         e->setto = ATTR__TRUE;
184                 else {
185                         e->setto = xmemdupz(equals + 1, ep - equals - 1);
186                 }
187                 e->attr = git_attr_internal(cp, len);
188         }
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)
195         int namelen;
196         int num_attr, i;
197         const char *cp, *name, *states;
198         struct match_attr *res = NULL;
199         int is_macro;
201         cp = line + strspn(line, blank);
202         if (!*cp || *cp == '#')
203                 return NULL;
204         name = cp;
205         namelen = strcspn(name, blank);
206         if (strlen(ATTRIBUTE_MACRO_PREFIX) < namelen &&
207             !prefixcmp(name, ATTRIBUTE_MACRO_PREFIX)) {
208                 if (!macro_ok) {
209                         fprintf(stderr, "%s not allowed: %s:%d\n",
210                                 name, src, lineno);
211                         return NULL;
212                 }
213                 is_macro = 1;
214                 name += strlen(ATTRIBUTE_MACRO_PREFIX);
215                 name += strspn(name, blank);
216                 namelen = strcspn(name, blank);
217                 if (invalid_attr_name(name, namelen)) {
218                         fprintf(stderr,
219                                 "%.*s is not a valid attribute name: %s:%d\n",
220                                 namelen, name, src, lineno);
221                         return NULL;
222                 }
223         }
224         else
225                 is_macro = 0;
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);
233                 if (!cp)
234                         return NULL;
235         }
237         res = xcalloc(1,
238                       sizeof(*res) +
239                       sizeof(struct attr_state) * num_attr +
240                       (is_macro ? 0 : namelen + 1));
241         if (is_macro)
242                 res->u.attr = git_attr_internal(name, namelen);
243         else {
244                 res->u.pattern = (char *)&(res->state[num_attr]);
245                 memcpy(res->u.pattern, name, namelen);
246                 res->u.pattern[namelen] = 0;
247         }
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]));
254         }
256         return res;
259 /*
260  * Like info/exclude and .gitignore, the attribute information can
261  * come from many places.
262  *
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.
267  *
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
274  * .gitignore
275  */
277 static struct attr_stack {
278         struct attr_stack *prev;
279         char *origin;
280         unsigned num_matches;
281         unsigned alloc;
282         struct match_attr **attrs;
283 } *attr_stack;
285 static void free_attr_elem(struct attr_stack *e)
287         int i;
288         free(e->origin);
289         for (i = 0; i < e->num_matches; i++) {
290                 struct match_attr *a = e->attrs[i];
291                 int j;
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)
298                                 ;
299                         else
300                                 free((char *) setto);
301                 }
302                 free(a);
303         }
304         free(e->attrs);
305         free(e);
308 static const char *builtin_attr[] = {
309         "[attr]binary -diff -text",
310         NULL,
311 };
313 static void handle_attr_line(struct attr_stack *res,
314                              const char *line,
315                              const char *src,
316                              int lineno,
317                              int macro_ok)
319         struct match_attr *a;
321         a = parse_attr_line(line, src, lineno, macro_ok);
322         if (!a)
323                 return;
324         if (res->alloc <= res->num_matches) {
325                 res->alloc = alloc_nr(res->num_matches);
326                 res->attrs = xrealloc(res->attrs,
327                                       sizeof(struct match_attr *) *
328                                       res->alloc);
329         }
330         res->attrs[res->num_matches++] = a;
333 static struct attr_stack *read_attr_from_array(const char **list)
335         struct attr_stack *res;
336         const char *line;
337         int lineno = 0;
339         res = xcalloc(1, sizeof(*res));
340         while ((line = *(list++)) != NULL)
341                 handle_attr_line(res, line, "[builtin]", ++lineno, 1);
342         return res;
345 static enum git_attr_direction direction;
346 static struct index_state *use_index;
348 static struct attr_stack *read_attr_from_file(const char *path, int macro_ok)
350         FILE *fp = fopen(path, "r");
351         struct attr_stack *res;
352         char buf[2048];
353         int lineno = 0;
355         if (!fp)
356                 return NULL;
357         res = xcalloc(1, sizeof(*res));
358         while (fgets(buf, sizeof(buf), fp))
359                 handle_attr_line(res, buf, path, ++lineno, macro_ok);
360         fclose(fp);
361         return res;
364 static void *read_index_data(const char *path)
366         int pos, len;
367         unsigned long sz;
368         enum object_type type;
369         void *data;
370         struct index_state *istate = use_index ? use_index : &the_index;
372         len = strlen(path);
373         pos = index_name_pos(istate, path, len);
374         if (pos < 0) {
375                 /*
376                  * We might be in the middle of a merge, in which
377                  * case we would read stage #2 (ours).
378                  */
379                 int i;
380                 for (i = -pos - 1;
381                      (pos < 0 && i < istate->cache_nr &&
382                       !strcmp(istate->cache[i]->name, path));
383                      i++)
384                         if (ce_stage(istate->cache[i]) == 2)
385                                 pos = i;
386         }
387         if (pos < 0)
388                 return NULL;
389         data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
390         if (!data || type != OBJ_BLOB) {
391                 free(data);
392                 return NULL;
393         }
394         return data;
397 static struct attr_stack *read_attr_from_index(const char *path, int macro_ok)
399         struct attr_stack *res;
400         char *buf, *sp;
401         int lineno = 0;
403         buf = read_index_data(path);
404         if (!buf)
405                 return NULL;
407         res = xcalloc(1, sizeof(*res));
408         for (sp = buf; *sp; ) {
409                 char *ep;
410                 int more;
411                 for (ep = sp; *ep && *ep != '\n'; ep++)
412                         ;
413                 more = (*ep == '\n');
414                 *ep = '\0';
415                 handle_attr_line(res, sp, path, ++lineno, macro_ok);
416                 sp = ep + more;
417         }
418         free(buf);
419         return res;
422 static struct attr_stack *read_attr(const char *path, int macro_ok)
424         struct attr_stack *res;
426         if (direction == GIT_ATTR_CHECKOUT) {
427                 res = read_attr_from_index(path, macro_ok);
428                 if (!res)
429                         res = read_attr_from_file(path, macro_ok);
430         }
431         else if (direction == GIT_ATTR_CHECKIN) {
432                 res = read_attr_from_file(path, macro_ok);
433                 if (!res)
434                         /*
435                          * There is no checked out .gitattributes file there, but
436                          * we might have it in the index.  We allow operation in a
437                          * sparsely checked out work tree, so read from it.
438                          */
439                         res = read_attr_from_index(path, macro_ok);
440         }
441         else
442                 res = read_attr_from_index(path, macro_ok);
443         if (!res)
444                 res = xcalloc(1, sizeof(*res));
445         return res;
448 #if DEBUG_ATTR
449 static void debug_info(const char *what, struct attr_stack *elem)
451         fprintf(stderr, "%s: %s\n", what, elem->origin ? elem->origin : "()");
453 static void debug_set(const char *what, const char *match, struct git_attr *attr, const void *v)
455         const char *value = v;
457         if (ATTR_TRUE(value))
458                 value = "set";
459         else if (ATTR_FALSE(value))
460                 value = "unset";
461         else if (ATTR_UNSET(value))
462                 value = "unspecified";
464         fprintf(stderr, "%s: %s => %s (%s)\n",
465                 what, attr->name, (char *) value, match);
467 #define debug_push(a) debug_info("push", (a))
468 #define debug_pop(a) debug_info("pop", (a))
469 #else
470 #define debug_push(a) do { ; } while (0)
471 #define debug_pop(a) do { ; } while (0)
472 #define debug_set(a,b,c,d) do { ; } while (0)
473 #endif
475 static void drop_attr_stack(void)
477         while (attr_stack) {
478                 struct attr_stack *elem = attr_stack;
479                 attr_stack = elem->prev;
480                 free_attr_elem(elem);
481         }
484 static const char *git_etc_gitattributes(void)
486         static const char *system_wide;
487         if (!system_wide)
488                 system_wide = system_path(ETC_GITATTRIBUTES);
489         return system_wide;
492 static int git_attr_system(void)
494         return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
497 static void bootstrap_attr_stack(void)
499         struct attr_stack *elem;
501         if (attr_stack)
502                 return;
504         elem = read_attr_from_array(builtin_attr);
505         elem->origin = NULL;
506         elem->prev = attr_stack;
507         attr_stack = elem;
509         if (git_attr_system()) {
510                 elem = read_attr_from_file(git_etc_gitattributes(), 1);
511                 if (elem) {
512                         elem->origin = NULL;
513                         elem->prev = attr_stack;
514                         attr_stack = elem;
515                 }
516         }
518         if (git_attributes_file) {
519                 elem = read_attr_from_file(git_attributes_file, 1);
520                 if (elem) {
521                         elem->origin = NULL;
522                         elem->prev = attr_stack;
523                         attr_stack = elem;
524                 }
525         }
527         if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
528                 elem = read_attr(GITATTRIBUTES_FILE, 1);
529                 elem->origin = xstrdup("");
530                 elem->prev = attr_stack;
531                 attr_stack = elem;
532                 debug_push(elem);
533         }
535         elem = read_attr_from_file(git_path(INFOATTRIBUTES_FILE), 1);
536         if (!elem)
537                 elem = xcalloc(1, sizeof(*elem));
538         elem->origin = NULL;
539         elem->prev = attr_stack;
540         attr_stack = elem;
543 static void prepare_attr_stack(const char *path)
545         struct attr_stack *elem, *info;
546         int dirlen, len;
547         const char *cp;
549         cp = strrchr(path, '/');
550         if (!cp)
551                 dirlen = 0;
552         else
553                 dirlen = cp - path;
555         /*
556          * At the bottom of the attribute stack is the built-in
557          * set of attribute definitions, followed by the contents
558          * of $(prefix)/etc/gitattributes and a file specified by
559          * core.attributesfile.  Then, contents from
560          * .gitattribute files from directories closer to the
561          * root to the ones in deeper directories are pushed
562          * to the stack.  Finally, at the very top of the stack
563          * we always keep the contents of $GIT_DIR/info/attributes.
564          *
565          * When checking, we use entries from near the top of the
566          * stack, preferring $GIT_DIR/info/attributes, then
567          * .gitattributes in deeper directories to shallower ones,
568          * and finally use the built-in set as the default.
569          */
570         bootstrap_attr_stack();
572         /*
573          * Pop the "info" one that is always at the top of the stack.
574          */
575         info = attr_stack;
576         attr_stack = info->prev;
578         /*
579          * Pop the ones from directories that are not the prefix of
580          * the path we are checking. Break out of the loop when we see
581          * the root one (whose origin is an empty string "") or the builtin
582          * one (whose origin is NULL) without popping it.
583          */
584         while (attr_stack->origin) {
585                 int namelen = strlen(attr_stack->origin);
587                 elem = attr_stack;
588                 if (namelen <= dirlen &&
589                     !strncmp(elem->origin, path, namelen) &&
590                     (!namelen || path[namelen] == '/'))
591                         break;
593                 debug_pop(elem);
594                 attr_stack = elem->prev;
595                 free_attr_elem(elem);
596         }
598         /*
599          * Read from parent directories and push them down
600          */
601         if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
602                 /*
603                  * bootstrap_attr_stack() should have added, and the
604                  * above loop should have stopped before popping, the
605                  * root element whose attr_stack->origin is set to an
606                  * empty string.
607                  */
608                 struct strbuf pathbuf = STRBUF_INIT;
610                 assert(attr_stack->origin);
611                 while (1) {
612                         len = strlen(attr_stack->origin);
613                         if (dirlen <= len)
614                                 break;
615                         cp = memchr(path + len + 1, '/', dirlen - len - 1);
616                         if (!cp)
617                                 cp = path + dirlen;
618                         strbuf_add(&pathbuf, path, cp - path);
619                         strbuf_addch(&pathbuf, '/');
620                         strbuf_addstr(&pathbuf, GITATTRIBUTES_FILE);
621                         elem = read_attr(pathbuf.buf, 0);
622                         strbuf_setlen(&pathbuf, cp - path);
623                         elem->origin = strbuf_detach(&pathbuf, NULL);
624                         elem->prev = attr_stack;
625                         attr_stack = elem;
626                         debug_push(elem);
627                 }
629                 strbuf_release(&pathbuf);
630         }
632         /*
633          * Finally push the "info" one at the top of the stack.
634          */
635         info->prev = attr_stack;
636         attr_stack = info;
639 static int path_matches(const char *pathname, int pathlen,
640                         const char *pattern,
641                         const char *base, int baselen)
643         if (!strchr(pattern, '/')) {
644                 /* match basename */
645                 const char *basename = strrchr(pathname, '/');
646                 basename = basename ? basename + 1 : pathname;
647                 return (fnmatch_icase(pattern, basename, 0) == 0);
648         }
649         /*
650          * match with FNM_PATHNAME; the pattern has base implicitly
651          * in front of it.
652          */
653         if (*pattern == '/')
654                 pattern++;
655         if (pathlen < baselen ||
656             (baselen && pathname[baselen] != '/') ||
657             strncmp(pathname, base, baselen))
658                 return 0;
659         if (baselen != 0)
660                 baselen++;
661         return fnmatch_icase(pattern, pathname + baselen, FNM_PATHNAME) == 0;
664 static int macroexpand_one(int attr_nr, int rem);
666 static int fill_one(const char *what, struct match_attr *a, int rem)
668         struct git_attr_check *check = check_all_attr;
669         int i;
671         for (i = a->num_attr - 1; 0 < rem && 0 <= i; i--) {
672                 struct git_attr *attr = a->state[i].attr;
673                 const char **n = &(check[attr->attr_nr].value);
674                 const char *v = a->state[i].setto;
676                 if (*n == ATTR__UNKNOWN) {
677                         debug_set(what,
678                                   a->is_macro ? a->u.attr->name : a->u.pattern,
679                                   attr, v);
680                         *n = v;
681                         rem--;
682                         rem = macroexpand_one(attr->attr_nr, rem);
683                 }
684         }
685         return rem;
688 static int fill(const char *path, int pathlen, struct attr_stack *stk, int rem)
690         int i;
691         const char *base = stk->origin ? stk->origin : "";
693         for (i = stk->num_matches - 1; 0 < rem && 0 <= i; i--) {
694                 struct match_attr *a = stk->attrs[i];
695                 if (a->is_macro)
696                         continue;
697                 if (path_matches(path, pathlen,
698                                  a->u.pattern, base, strlen(base)))
699                         rem = fill_one("fill", a, rem);
700         }
701         return rem;
704 static int macroexpand_one(int attr_nr, int rem)
706         struct attr_stack *stk;
707         struct match_attr *a = NULL;
708         int i;
710         if (check_all_attr[attr_nr].value != ATTR__TRUE)
711                 return rem;
713         for (stk = attr_stack; !a && stk; stk = stk->prev)
714                 for (i = stk->num_matches - 1; !a && 0 <= i; i--) {
715                         struct match_attr *ma = stk->attrs[i];
716                         if (!ma->is_macro)
717                                 continue;
718                         if (ma->u.attr->attr_nr == attr_nr)
719                                 a = ma;
720                 }
722         if (a)
723                 rem = fill_one("expand", a, rem);
725         return rem;
728 /*
729  * Collect all attributes for path into the array pointed to by
730  * check_all_attr.
731  */
732 static void collect_all_attrs(const char *path)
734         struct attr_stack *stk;
735         int i, pathlen, rem;
737         prepare_attr_stack(path);
738         for (i = 0; i < attr_nr; i++)
739                 check_all_attr[i].value = ATTR__UNKNOWN;
741         pathlen = strlen(path);
742         rem = attr_nr;
743         for (stk = attr_stack; 0 < rem && stk; stk = stk->prev)
744                 rem = fill(path, pathlen, stk, rem);
747 int git_check_attr(const char *path, int num, struct git_attr_check *check)
749         int i;
751         collect_all_attrs(path);
753         for (i = 0; i < num; i++) {
754                 const char *value = check_all_attr[check[i].attr->attr_nr].value;
755                 if (value == ATTR__UNKNOWN)
756                         value = ATTR__UNSET;
757                 check[i].value = value;
758         }
760         return 0;
763 int git_all_attrs(const char *path, int *num, struct git_attr_check **check)
765         int i, count, j;
767         collect_all_attrs(path);
769         /* Count the number of attributes that are set. */
770         count = 0;
771         for (i = 0; i < attr_nr; i++) {
772                 const char *value = check_all_attr[i].value;
773                 if (value != ATTR__UNSET && value != ATTR__UNKNOWN)
774                         ++count;
775         }
776         *num = count;
777         *check = xmalloc(sizeof(**check) * count);
778         j = 0;
779         for (i = 0; i < attr_nr; i++) {
780                 const char *value = check_all_attr[i].value;
781                 if (value != ATTR__UNSET && value != ATTR__UNKNOWN) {
782                         (*check)[j].attr = check_all_attr[i].attr;
783                         (*check)[j].value = value;
784                         ++j;
785                 }
786         }
788         return 0;
791 void git_attr_set_direction(enum git_attr_direction new, struct index_state *istate)
793         enum git_attr_direction old = direction;
795         if (is_bare_repository() && new != GIT_ATTR_INDEX)
796                 die("BUG: non-INDEX attr direction in a bare repo");
798         direction = new;
799         if (new != old)
800                 drop_attr_stack();
801         use_index = istate;