1 #include "git-compat-util.h"
6 #include "environment.h"
8 static struct userdiff_driver
*drivers
;
10 static int drivers_alloc
;
12 #define PATTERNS(lang, rx, wrx) { \
17 .cflags = REG_EXTENDED, \
19 .word_regex = wrx "|[^[:space:]]|[\xc0-\xff][\x80-\xbf]+", \
20 .word_regex_multi_byte = wrx "|[^[:space:]]", \
22 #define IPATTERN(lang, rx, wrx) { \
27 .cflags = REG_EXTENDED | REG_ICASE, \
29 .word_regex = wrx "|[^[:space:]]|[\xc0-\xff][\x80-\xbf]+", \
30 .word_regex_multi_byte = wrx "|[^[:space:]]", \
34 * Built-in drivers for various languages, sorted by their names
35 * (except that the "default" is left at the end).
37 * When writing or updating patterns, assume that the contents these
38 * patterns are applied to are syntactically correct. The patterns
39 * can be simple without implementing all syntactical corner cases, as
40 * long as they are sufficiently permissive.
42 static struct userdiff_driver builtin_drivers
[] = {
44 "!^(.*[ \t])?(is[ \t]+new|renames|is[ \t]+separate)([ \t].*)?$\n"
45 "!^[ \t]*with[ \t].*$\n"
46 "^[ \t]*((procedure|function)[ \t]+.*)$\n"
47 "^[ \t]*((package|protected|task)[ \t]+.*)$",
49 "[a-zA-Z][a-zA-Z0-9_]*"
50 "|[-+]?[0-9][0-9#_.aAbBcCdDeEfF]*([eE][+-]?[0-9_]+)?"
51 "|=>|\\.\\.|\\*\\*|:=|/=|>=|<=|<<|>>|<>"),
53 /* Optional leading indentation */
55 /* Start of captured text */
58 /* POSIX identifier with mandatory parentheses */
59 "[a-zA-Z_][a-zA-Z0-9_]*[ \t]*\\([ \t]*\\))"
61 /* Bashism identifier with optional parentheses */
62 "(function[ \t]+[a-zA-Z_][a-zA-Z0-9_]*(([ \t]*\\([ \t]*\\))|([ \t]+))"
64 /* Optional whitespace */
66 /* Compound command starting with `{`, `(`, `((` or `[[` */
67 "(\\{|\\(\\(?|\\[\\[)"
68 /* End of captured text */
71 /* Characters not in the default $IFS value */
74 "(@[a-zA-Z]{1,}[ \t]*\\{{0,1}[ \t]*[^ \t\"@',\\#}{~%]*).*$",
76 "[={}\"]|[^={}\" \t]+"),
78 /* Jump targets or access declarations */
79 "!^[ \t]*[A-Za-z_][A-Za-z_0-9]*:[[:space:]]*($|/[/*])\n"
80 /* functions/methods, variables, and compounds at top level */
81 "^((::[[:space:]]*)?[A-Za-z_].*)$",
83 /* identifiers and keywords */
84 "[a-zA-Z_][a-zA-Z0-9_]*"
85 /* decimal and octal integers as well as floatingpoint numbers */
86 "|[0-9][0-9.]*([Ee][-+]?[0-9]+)?[fFlLuU]*"
87 /* hexadecimal and binary integers */
88 "|0[xXbB][0-9a-fA-F]+[lLuU]*"
89 /* floatingpoint numbers that begin with a decimal point */
90 "|\\.[0-9][0-9]*([Ee][-+]?[0-9]+)?[fFlL]?"
91 "|[-+*/<>%&^|=!]=|--|\\+\\+|<<=?|>>=?|&&|\\|\\||::|->\\*?|\\.\\*|<=>"),
94 * Jump over reserved keywords which are illegal method names, but which
95 * can be followed by parentheses without special characters in between,
96 * making them look like methods.
98 "!(^|[ \t]+)" /* Start of line or whitespace. */
99 "(do|while|for|foreach|if|else|new|default|return|switch|case|throw"
100 "|catch|using|lock|fixed)"
101 "([ \t(]+|$)\n" /* Whitespace, "(", or end of line. */
103 * Methods/constructors:
104 * The strategy is to identify a minimum of two groups (any combination
105 * of keywords/type/name) before the opening parenthesis, and without
106 * final unexpected characters, normally only used in ordinary statements.
108 "^[ \t]*" /* Remove leading whitespace. */
109 "(" /* Start chunk header capture. */
110 "(" /* First group. */
111 "[][[:alnum:]@_.]" /* Name. */
112 "(<[][[:alnum:]@_, \t<>]+>)?" /* Optional generic parameters. */
114 "([ \t]+" /* Subsequent groups, prepended with space. */
115 "([][[:alnum:]@_.](<[][[:alnum:]@_, \t<>]+>)?)+"
117 "[ \t]*" /* Optional space before parameters start. */
118 "\\(" /* Start of method parameters. */
119 "[^;]*" /* Allow complex parameters, but exclude statements (;). */
120 ")$\n" /* Close chunk header capture. */
123 * As with methods, expect a minimum of two groups. But, more trivial than
124 * methods, the vast majority of properties long enough to be worth
125 * showing a chunk header for don't include "=:;,()" on the line they are
126 * defined, since they don't have a parameter list.
129 "([][[:alnum:]@_.](<[][[:alnum:]@_, \t<>]+>)?)+"
131 "([][[:alnum:]@_.](<[][[:alnum:]@_, \t<>]+>)?)+"
132 ")+" /* Up to here, same as methods regex. */
133 "[^;=:,()]*" /* Compared to methods, no parameter list allowed. */
135 /* Type definitions */
136 "^[ \t]*(((static|public|internal|private|protected|new|unsafe|sealed|abstract|partial)[ \t]+)*(class|enum|interface|struct|record)[ \t]+.*)$\n"
138 "^[ \t]*(namespace[ \t]+.*)$",
140 "[a-zA-Z_][a-zA-Z0-9_]*"
141 "|[-+0-9.e]+[fFlL]?|0[xXbB]?[0-9a-fA-F]+[lL]?"
142 "|[-+*/<>%&^|=!]=|--|\\+\\+|<<=?|>>=?|&&|\\|\\||::|->"),
144 "![:;][[:space:]]*$\n"
145 "^[:[@.#]?[_a-z0-9].*$",
148 * This regex comes from W3C CSS specs. Should theoretically also
149 * allow ISO 10646 characters U+00A0 and higher,
150 * but they are not handled in this regex.
152 "-?[_a-zA-Z][-_a-zA-Z0-9]*" /* identifiers */
153 "|-?[0-9]+|\\#[0-9a-fA-F]+" /* numbers */
158 /* lines beginning with a word optionally preceded by '&' or the root */
159 "^[ \t]*((/[ \t]*\\{|&?[a-zA-Z_]).*)",
161 /* Property names and math operators */
162 "[a-zA-Z0-9,._+?#-]+"
163 "|[-+*/%&^|!~]|>>|<<|&&|\\|\\|"),
165 "^[ \t]*((def(macro|module|impl|protocol|p)?|test)[ \t].*)$",
167 /* Atoms, names, and module attributes */
168 "[@:]?[a-zA-Z0-9@_?!]+"
169 /* Numbers with specific base */
170 "|[-+]?0[xob][0-9a-fA-F]+"
172 "|[-+]?[0-9][0-9_.]*([eE][-+]?[0-9_]+)?"
173 /* Operators and atoms that represent them */
174 "|:?(\\+\\+|--|\\.\\.|~~~|<>|\\^\\^\\^|<?\\|>|<<<?|>?>>|<<?~|~>?>|<~>|<=|>=|===?|!==?|=~|&&&?|\\|\\|\\|?|=>|<-|\\\\\\\\|->)"
175 /* Not real operators, but should be grouped */
176 "|:?%[A-Za-z0-9_.]\\{\\}?"),
178 /* Don't match comment lines */
180 /* Don't match 'module procedure' lines */
181 "!^[ \t]*MODULE[ \t]+PROCEDURE[ \t]\n"
182 /* Program, module, block data */
183 "^[ \t]*((END[ \t]+)?(PROGRAM|MODULE|BLOCK[ \t]+DATA"
184 /* Subroutines and functions */
185 "|([^!'\" \t]+[ \t]+)*(SUBROUTINE|FUNCTION))[ \t]+[A-Z].*)$",
187 "[a-zA-Z][a-zA-Z0-9_]*"
188 "|\\.([Ee][Qq]|[Nn][Ee]|[Gg][TtEe]|[Ll][TtEe]|[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[Aa][Nn][Dd]|[Oo][Rr]|[Nn]?[Ee][Qq][Vv]|[Nn][Oo][Tt])\\."
189 /* numbers and format statements like 2E14.4, or ES12.6, 9X.
190 * Don't worry about format statements without leading digits since
191 * they would have been matched above as a variable anyway. */
192 "|[-+]?[0-9.]+([AaIiDdEeFfLlTtXx][Ss]?[-+]?[0-9.]*)?(_[a-zA-Z0-9][a-zA-Z0-9_]*)?"
193 "|//|\\*\\*|::|[/<>=]="),
195 "^((\\.[^.]|(int|ext|est|int\\.?/ext|i/e)[. ]).*)$",
200 "^[ \t]*(func[ \t]*.*(\\{[ \t]*)?)\n"
201 /* Structs and interfaces */
202 "^[ \t]*(type[ \t].*(struct|interface)[ \t]*(\\{[ \t]*)?)",
204 "[a-zA-Z_][a-zA-Z0-9_]*"
205 "|[-+0-9.eE]+i?|0[xX]?[0-9a-fA-F]+i?"
206 "|[-+*/<>%&^|=!:]=|--|\\+\\+|<<=?|>>=?|&\\^=?|&&|\\|\\||<-|\\.{3}"),
208 "^[ \t]*(<[Hh][1-6]([ \t].*)?>.*)$",
212 "!^[ \t]*(catch|do|for|if|instanceof|new|return|switch|throw|while)\n"
213 /* Class, enum, interface, and record declarations */
214 "^[ \t]*(([a-z-]+[ \t]+)*(class|enum|interface|record)[ \t]+.*)$\n"
215 /* Method definitions; note that constructor signatures are not */
216 /* matched because they are indistinguishable from method calls. */
217 "^[ \t]*(([A-Za-z_<>&][][?&<>.,A-Za-z_0-9]*[ \t]+)+[A-Za-z_][A-Za-z_0-9]*[ \t]*\\([^;]*)$",
219 "[a-zA-Z_][a-zA-Z0-9_]*"
220 "|[-+0-9.e]+[fFlL]?|0[xXbB]?[0-9a-fA-F]+[lL]?"
222 "|--|\\+\\+|<<=?|>>>?=?|&&|\\|\\|"),
224 "^[ \t]*(([a-z]+[ \t]+)*(fun|class|interface)[ \t]+.*)$",
226 "[a-zA-Z_][a-zA-Z0-9_]*"
227 /* hexadecimal and binary numbers */
228 "|0[xXbB][0-9a-fA-F_]+[lLuU]*"
229 /* integers and floats */
230 "|[0-9][0-9_]*([.][0-9_]*)?([Ee][-+]?[0-9]+)?[fFlLuU]*"
231 /* floating point numbers beginning with decimal point */
232 "|[.][0-9][0-9_]*([Ee][-+]?[0-9]+)?[fFlLuU]?"
233 /* unary and binary operators */
234 "|[-+*/<>%&^|=!]==?|--|\\+\\+|<<=|>>=|&&|\\|\\||->|\\.\\*|!!|[?:.][.:]"),
236 "^ {0,3}#{1,6}[ \t].*",
241 * Octave pattern is mostly the same as matlab, except that '%%%' and
242 * '##' can also be used to begin code sections, in addition to '%%'
243 * that is understood by both.
245 "^[[:space:]]*((classdef|function)[[:space:]].*)$|^(%%%?|##)[[:space:]].*$",
247 "[a-zA-Z_][a-zA-Z0-9_]*|[-+0-9.e]+|[=~<>]=|\\.[*/\\^']|\\|\\||&&"),
249 /* Negate C statements that can look like functions */
250 "!^[ \t]*(do|for|if|else|return|switch|while)\n"
251 /* Objective-C methods */
252 "^[ \t]*([-+][ \t]*\\([ \t]*[A-Za-z_][A-Za-z_0-9* \t]*\\)[ \t]*[A-Za-z_].*)$\n"
254 "^[ \t]*(([A-Za-z_][A-Za-z_0-9]*[ \t]+)+[A-Za-z_][A-Za-z_0-9]*[ \t]*\\([^;]*)$\n"
255 /* Objective-C class/protocol definitions */
256 "^(@(implementation|interface|protocol)[ \t].*)$",
258 "[a-zA-Z_][a-zA-Z0-9_]*"
259 "|[-+0-9.e]+[fFlL]?|0[xXbB]?[0-9a-fA-F]+[lL]?"
260 "|[-+*/<>%&^|=!]=|--|\\+\\+|<<=?|>>=?|&&|\\|\\||::|->"),
262 "^(((class[ \t]+)?(procedure|function)|constructor|destructor|interface"
263 "|implementation|initialization|finalization)[ \t]*.*)$\n"
264 "^(.*=[ \t]*(class|record).*)$",
266 "[a-zA-Z_][a-zA-Z0-9_]*"
267 "|[-+0-9.e]+|0[xXbB]?[0-9a-fA-F]+"
268 "|<>|<=|>=|:=|\\.\\."),
271 "^sub [[:alnum:]_':]+[ \t]*"
272 "(\\([^)]*\\)[ \t]*)?" /* prototype */
274 * Attributes. A regex can't count nested parentheses,
275 * so just slurp up whatever we see, taking care not
276 * to accept lines like "sub foo; # defined elsewhere".
278 * An attribute could contain a semicolon, but at that
279 * point it seems reasonable enough to give up.
282 "(\\{[ \t]*)?" /* brace can come here or on the next line */
283 "(#.*)?$\n" /* comment */
284 "^(BEGIN|END|INIT|CHECK|UNITCHECK|AUTOLOAD|DESTROY)[ \t]*"
285 "(\\{[ \t]*)?" /* brace can come here or on the next line */
287 "^=head[0-9] .*", /* POD */
289 "[[:alpha:]_'][[:alnum:]_']*"
290 "|0[xb]?[0-9a-fA-F_]*"
291 /* taking care not to interpret 3..5 as (3.)(.5) */
292 "|[0-9a-fA-F_]+(\\.[0-9a-fA-F_]+)?([eE][-+]?[0-9_]+)?"
293 "|=>|-[rwxoRWXOezsfdlpSugkbctTBMAC>]|~~|::"
294 "|&&=|\\|\\|=|//=|\\*\\*="
295 "|&&|\\|\\||//|\\+\\+|--|\\*\\*|\\.\\.\\.?"
300 "^[\t ]*(((public|protected|private|static|abstract|final)[\t ]+)*function.*)$\n"
301 "^[\t ]*((((final|abstract)[\t ]+)?class|enum|interface|trait).*)$",
303 "[a-zA-Z_][a-zA-Z0-9_]*"
304 "|[-+0-9.e]+|0[xXbB]?[0-9a-fA-F]+"
305 "|[-+*/<>%&^|=!.]=|--|\\+\\+|<<=?|>>=?|===|&&|\\|\\||::|->"),
307 "^[ \t]*((class|(async[ \t]+)?def)[ \t].*)$",
309 "[a-zA-Z_][a-zA-Z0-9_]*"
310 "|[-+0-9.e]+[jJlL]?|0[xX]?[0-9a-fA-F]+[lL]?"
311 "|[-+*/<>%&^|=!]=|//=?|<<=?|>>=?|\\*\\*=?"),
314 "^[ \t]*((class|module|def)[ \t].*)$",
316 "(@|@@|\\$)?[a-zA-Z_][a-zA-Z0-9_]*"
317 "|[-+0-9.e]+|0[xXbB]?[0-9a-fA-F]+|\\?(\\\\C-)?(\\\\M-)?."
318 "|//=?|[-+*/<>%&^|=!]=|<<=?|>>=?|===|\\.{1,3}|::|[!=]~"),
320 "^[\t ]*((pub(\\([^\\)]+\\))?[\t ]+)?((async|const|unsafe|extern([\t ]+\"[^\"]+\"))[\t ]+)?(struct|enum|union|mod|trait|fn|impl|macro_rules!)[< \t]+[^;]*)$",
322 "[a-zA-Z_][a-zA-Z0-9_]*"
323 "|[0-9][0-9_a-fA-Fiosuxz]*(\\.([0-9]*[eE][+-]?)?[0-9_fF]*)?"
324 "|[-+*\\/<>%&^|=!:]=|<<=?|>>=?|&&|\\|\\||->|=>|\\.{2}=|\\.{3}|::"),
326 "^[\t ]*(\\(((define|def(struct|syntax|class|method|rules|record|proto|alias)?)[-*/ \t]|(library|module|struct|class)[*+ \t]).*)$",
328 * R7RS valid identifiers include any sequence enclosed
329 * within vertical lines having no backslashes
332 /* All other words should be delimited by spaces or parentheses */
333 "|([^][)(}{[ \t])+"),
334 PATTERNS("tex", "^(\\\\((sub)*section|chapter|part)\\*{0,1}\\{.*)$",
335 "\\\\[a-zA-Z@]+|\\\\.|([a-zA-Z0-9]|[^\x01-\x7f])+"),
336 { .name
= "default", .binary
= -1 },
341 static struct userdiff_driver driver_true
= {
346 static struct userdiff_driver driver_false
= {
351 struct find_by_namelen_data
{
354 struct userdiff_driver
*driver
;
357 static int userdiff_find_by_namelen_cb(struct userdiff_driver
*driver
,
358 enum userdiff_driver_type type UNUSED
,
361 struct find_by_namelen_data
*cb_data
= priv
;
363 if (!xstrncmpz(driver
->name
, cb_data
->name
, cb_data
->len
)) {
364 cb_data
->driver
= driver
;
365 return 1; /* tell the caller to stop iterating */
370 static int regexec_supports_multi_byte_chars(void)
372 static const char not_space
[] = "[^[:space:]]";
373 static const char utf8_multi_byte_char
[] = "\xc2\xa3";
376 static int result
= -1;
380 if (regcomp(&re
, not_space
, REG_EXTENDED
))
381 BUG("invalid regular expression: %s", not_space
);
382 result
= !regexec(&re
, utf8_multi_byte_char
, 1, &match
, 0) &&
384 match
.rm_eo
== strlen(utf8_multi_byte_char
);
389 static struct userdiff_driver
*userdiff_find_by_namelen(const char *name
, size_t len
)
391 struct find_by_namelen_data udcbdata
= {
395 for_each_userdiff_driver(userdiff_find_by_namelen_cb
, &udcbdata
);
396 return udcbdata
.driver
;
399 static int parse_funcname(struct userdiff_funcname
*f
, const char *k
,
400 const char *v
, int cflags
)
403 FREE_AND_NULL(f
->pattern_owned
);
404 if (git_config_string(&f
->pattern_owned
, k
, v
) < 0)
406 f
->pattern
= f
->pattern_owned
;
411 static int parse_tristate(int *b
, const char *k
, const char *v
)
413 if (v
&& !strcasecmp(v
, "auto"))
416 *b
= git_config_bool(k
, v
);
420 static int parse_bool(int *b
, const char *k
, const char *v
)
422 *b
= git_config_bool(k
, v
);
426 int userdiff_config(const char *k
, const char *v
)
428 struct userdiff_driver
*drv
;
429 const char *name
, *type
;
432 if (parse_config_key(k
, "diff", &name
, &namelen
, &type
) || !name
)
435 drv
= userdiff_find_by_namelen(name
, namelen
);
437 ALLOC_GROW(drivers
, ndrivers
+1, drivers_alloc
);
438 drv
= &drivers
[ndrivers
++];
439 memset(drv
, 0, sizeof(*drv
));
440 drv
->name
= xmemdupz(name
, namelen
);
444 if (!strcmp(type
, "funcname"))
445 return parse_funcname(&drv
->funcname
, k
, v
, 0);
446 if (!strcmp(type
, "xfuncname"))
447 return parse_funcname(&drv
->funcname
, k
, v
, REG_EXTENDED
);
448 if (!strcmp(type
, "binary"))
449 return parse_tristate(&drv
->binary
, k
, v
);
450 if (!strcmp(type
, "command")) {
451 FREE_AND_NULL(drv
->external
.cmd
);
452 return git_config_string(&drv
->external
.cmd
, k
, v
);
454 if (!strcmp(type
, "trustexitcode")) {
455 drv
->external
.trust_exit_code
= git_config_bool(k
, v
);
458 if (!strcmp(type
, "textconv")) {
460 FREE_AND_NULL(drv
->textconv_owned
);
461 ret
= git_config_string(&drv
->textconv_owned
, k
, v
);
462 drv
->textconv
= drv
->textconv_owned
;
465 if (!strcmp(type
, "cachetextconv"))
466 return parse_bool(&drv
->textconv_want_cache
, k
, v
);
467 if (!strcmp(type
, "wordregex")) {
469 FREE_AND_NULL(drv
->word_regex_owned
);
470 ret
= git_config_string(&drv
->word_regex_owned
, k
, v
);
471 drv
->word_regex
= drv
->word_regex_owned
;
474 if (!strcmp(type
, "algorithm")) {
476 FREE_AND_NULL(drv
->algorithm_owned
);
477 ret
= git_config_string(&drv
->algorithm_owned
, k
, v
);
478 drv
->algorithm
= drv
->algorithm_owned
;
485 struct userdiff_driver
*userdiff_find_by_name(const char *name
)
487 int len
= strlen(name
);
488 struct userdiff_driver
*driver
= userdiff_find_by_namelen(name
, len
);
489 if (driver
&& driver
->word_regex_multi_byte
) {
490 if (regexec_supports_multi_byte_chars())
491 driver
->word_regex
= driver
->word_regex_multi_byte
;
492 driver
->word_regex_multi_byte
= NULL
;
497 struct userdiff_driver
*userdiff_find_by_path(struct index_state
*istate
,
500 static struct attr_check
*check
;
503 check
= attr_check_initl("diff", NULL
);
506 git_check_attr(istate
, path
, check
);
508 if (ATTR_TRUE(check
->items
[0].value
))
510 if (ATTR_FALSE(check
->items
[0].value
))
511 return &driver_false
;
512 if (ATTR_UNSET(check
->items
[0].value
))
514 return userdiff_find_by_name(check
->items
[0].value
);
517 struct userdiff_driver
*userdiff_get_textconv(struct repository
*r
,
518 struct userdiff_driver
*driver
)
520 if (!driver
->textconv
)
523 if (driver
->textconv_want_cache
&& !driver
->textconv_cache
&&
525 struct notes_cache
*c
= xmalloc(sizeof(*c
));
526 struct strbuf name
= STRBUF_INIT
;
528 strbuf_addf(&name
, "textconv/%s", driver
->name
);
529 notes_cache_init(r
, c
, name
.buf
, driver
->textconv
);
530 driver
->textconv_cache
= c
;
531 strbuf_release(&name
);
537 static int for_each_userdiff_driver_list(each_userdiff_driver_fn fn
,
538 enum userdiff_driver_type type
, void *cb_data
,
539 struct userdiff_driver
*drv
,
544 for (i
= 0; i
< drv_size
; i
++) {
545 struct userdiff_driver
*item
= drv
+ i
;
546 if ((ret
= fn(item
, type
, cb_data
)))
552 int for_each_userdiff_driver(each_userdiff_driver_fn fn
, void *cb_data
)
556 ret
= for_each_userdiff_driver_list(fn
, USERDIFF_DRIVER_TYPE_CUSTOM
,
557 cb_data
, drivers
, ndrivers
);
561 ret
= for_each_userdiff_driver_list(fn
, USERDIFF_DRIVER_TYPE_BUILTIN
,
562 cb_data
, builtin_drivers
,
563 ARRAY_SIZE(builtin_drivers
));