4 #include "levenshtein.h"
6 #include "common-cmds.h"
7 #include "string-list.h"
11 void add_cmdname(struct cmdnames *cmds, const char *name, int len)
13 struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1);
16 memcpy(ent->name, name, len);
19 ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
20 cmds->names[cmds->cnt++] = ent;
23 static void clean_cmdnames(struct cmdnames *cmds)
26 for (i = 0; i < cmds->cnt; ++i)
33 static int cmdname_compare(const void *a_, const void *b_)
35 struct cmdname *a = *(struct cmdname **)a_;
36 struct cmdname *b = *(struct cmdname **)b_;
37 return strcmp(a->name, b->name);
40 static void uniq(struct cmdnames *cmds)
47 for (i = j = 1; i < cmds->cnt; i++) {
48 if (!strcmp(cmds->names[i]->name, cmds->names[j-1]->name))
51 cmds->names[j++] = cmds->names[i];
57 void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
63 while (ci < cmds->cnt && ei < excludes->cnt) {
64 cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
66 cmds->names[cj++] = cmds->names[ci++];
73 while (ci < cmds->cnt)
74 cmds->names[cj++] = cmds->names[ci++];
79 static void pretty_print_string_list(struct cmdnames *cmds,
82 struct string_list list = STRING_LIST_INIT_NODUP;
83 struct column_options copts;
86 for (i = 0; i < cmds->cnt; i++)
87 string_list_append(&list, cmds->names[i]->name);
89 * always enable column display, we only consult column.*
90 * about layout strategy and stuff
92 colopts = (colopts & ~COL_ENABLE_MASK) | COL_ENABLED;
93 memset(&copts, 0, sizeof(copts));
96 print_columns(&list, colopts, &copts);
97 string_list_clear(&list, 0);
100 static int is_executable(const char *name)
104 if (stat(name, &st) || /* stat, not lstat */
105 !S_ISREG(st.st_mode))
108 #if defined(WIN32) || defined(__CYGWIN__)
109 #if defined(__CYGWIN__)
110 if ((st.st_mode & S_IXUSR) == 0)
112 { /* cannot trust the executable bit, peek into the file instead */
115 int fd = open(name, O_RDONLY);
116 st.st_mode &= ~S_IXUSR;
118 n = read(fd, buf, 2);
120 /* DOS executables start with "MZ" */
121 if (!strcmp(buf, "#!") || !strcmp(buf, "MZ"))
122 st.st_mode |= S_IXUSR;
127 return st.st_mode & S_IXUSR;
130 static void list_commands_in_dir(struct cmdnames *cmds,
135 DIR *dir = opendir(path);
137 struct strbuf buf = STRBUF_INIT;
144 prefix_len = strlen(prefix);
146 strbuf_addf(&buf, "%s/", path);
149 while ((de = readdir(dir)) != NULL) {
152 if (prefixcmp(de->d_name, prefix))
155 strbuf_setlen(&buf, len);
156 strbuf_addstr(&buf, de->d_name);
157 if (!is_executable(buf.buf))
160 entlen = strlen(de->d_name) - prefix_len;
161 if (has_extension(de->d_name, ".exe"))
164 add_cmdname(cmds, de->d_name + prefix_len, entlen);
167 strbuf_release(&buf);
170 void load_command_list(const char *prefix,
171 struct cmdnames *main_cmds,
172 struct cmdnames *other_cmds)
174 const char *env_path = getenv("PATH");
175 const char *exec_path = git_exec_path();
178 list_commands_in_dir(main_cmds, exec_path, prefix);
179 qsort(main_cmds->names, main_cmds->cnt,
180 sizeof(*main_cmds->names), cmdname_compare);
185 char *paths, *path, *colon;
186 path = paths = xstrdup(env_path);
188 if ((colon = strchr(path, PATH_SEP)))
190 if (!exec_path || strcmp(path, exec_path))
191 list_commands_in_dir(other_cmds, path, prefix);
199 qsort(other_cmds->names, other_cmds->cnt,
200 sizeof(*other_cmds->names), cmdname_compare);
203 exclude_cmds(other_cmds, main_cmds);
206 void list_commands(unsigned int colopts,
207 struct cmdnames *main_cmds, struct cmdnames *other_cmds)
209 if (main_cmds->cnt) {
210 const char *exec_path = git_exec_path();
211 printf_ln(_("available git commands in '%s'"), exec_path);
213 pretty_print_string_list(main_cmds, colopts);
217 if (other_cmds->cnt) {
218 printf_ln(_("git commands available from elsewhere on your $PATH"));
220 pretty_print_string_list(other_cmds, colopts);
225 int is_in_cmdlist(struct cmdnames *c, const char *s)
228 for (i = 0; i < c->cnt; i++)
229 if (!strcmp(s, c->names[i]->name))
234 static int autocorrect;
235 static struct cmdnames aliases;
237 static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
239 if (!strcmp(var, "help.autocorrect"))
240 autocorrect = git_config_int(var,value);
241 /* Also use aliases for command lookup */
242 if (!prefixcmp(var, "alias."))
243 add_cmdname(&aliases, var + 6, strlen(var + 6));
245 return git_default_config(var, value, cb);
248 static int levenshtein_compare(const void *p1, const void *p2)
250 const struct cmdname *const *c1 = p1, *const *c2 = p2;
251 const char *s1 = (*c1)->name, *s2 = (*c2)->name;
254 return l1 != l2 ? l1 - l2 : strcmp(s1, s2);
257 static void add_cmd_list(struct cmdnames *cmds, struct cmdnames *old)
260 ALLOC_GROW(cmds->names, cmds->cnt + old->cnt, cmds->alloc);
262 for (i = 0; i < old->cnt; i++)
263 cmds->names[cmds->cnt++] = old->names[i];
269 /* An empirically derived magic number */
270 #define SIMILARITY_FLOOR 7
271 #define SIMILAR_ENOUGH(x) ((x) < SIMILARITY_FLOOR)
273 static const char bad_interpreter_advice[] =
274 N_("'%s' appears to be a git command, but we were not\n"
275 "able to execute it. Maybe git-%s is broken?");
277 const char *help_unknown_cmd(const char *cmd)
279 int i, n, best_similarity = 0;
280 struct cmdnames main_cmds, other_cmds;
282 memset(&main_cmds, 0, sizeof(main_cmds));
283 memset(&other_cmds, 0, sizeof(other_cmds));
284 memset(&aliases, 0, sizeof(aliases));
286 git_config(git_unknown_cmd_config, NULL);
288 load_command_list("git-", &main_cmds, &other_cmds);
290 add_cmd_list(&main_cmds, &aliases);
291 add_cmd_list(&main_cmds, &other_cmds);
292 qsort(main_cmds.names, main_cmds.cnt,
293 sizeof(main_cmds.names), cmdname_compare);
296 /* This abuses cmdname->len for levenshtein distance */
297 for (i = 0, n = 0; i < main_cmds.cnt; i++) {
298 int cmp = 0; /* avoid compiler stupidity */
299 const char *candidate = main_cmds.names[i]->name;
302 * An exact match means we have the command, but
303 * for some reason exec'ing it gave us ENOENT; probably
304 * it's a bad interpreter in the #! line.
306 if (!strcmp(candidate, cmd))
307 die(_(bad_interpreter_advice), cmd, cmd);
309 /* Does the candidate appear in common_cmds list? */
310 while (n < ARRAY_SIZE(common_cmds) &&
311 (cmp = strcmp(common_cmds[n].name, candidate)) < 0)
313 if ((n < ARRAY_SIZE(common_cmds)) && !cmp) {
314 /* Yes, this is one of the common commands */
315 n++; /* use the entry from common_cmds[] */
316 if (!prefixcmp(candidate, cmd)) {
317 /* Give prefix match a very good score */
318 main_cmds.names[i]->len = 0;
323 main_cmds.names[i]->len =
324 levenshtein(cmd, candidate, 0, 2, 1, 3) + 1;
327 qsort(main_cmds.names, main_cmds.cnt,
328 sizeof(*main_cmds.names), levenshtein_compare);
331 die(_("Uh oh. Your system reports no Git commands at all."));
333 /* skip and count prefix matches */
334 for (n = 0; n < main_cmds.cnt && !main_cmds.names[n]->len; n++)
335 ; /* still counting */
337 if (main_cmds.cnt <= n) {
338 /* prefix matches with everything? that is too ambiguous */
339 best_similarity = SIMILARITY_FLOOR + 1;
341 /* count all the most similar ones */
342 for (best_similarity = main_cmds.names[n++]->len;
343 (n < main_cmds.cnt &&
344 best_similarity == main_cmds.names[n]->len);
346 ; /* still counting */
348 if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) {
349 const char *assumed = main_cmds.names[0]->name;
350 main_cmds.names[0] = NULL;
351 clean_cmdnames(&main_cmds);
353 _("WARNING: You called a Git command named '%s', "
354 "which does not exist.\n"
355 "Continuing under the assumption that you meant '%s'"),
357 if (autocorrect > 0) {
358 fprintf_ln(stderr, _("in %0.1f seconds automatically..."),
359 (float)autocorrect/10.0);
360 poll(NULL, 0, autocorrect * 100);
365 fprintf_ln(stderr, _("git: '%s' is not a git command. See 'git --help'."), cmd);
367 if (SIMILAR_ENOUGH(best_similarity)) {
369 Q_("\nDid you mean this?",
370 "\nDid you mean one of these?",
373 for (i = 0; i < n; i++)
374 fprintf(stderr, "\t%s\n", main_cmds.names[i]->name);
380 int cmd_version(int argc, const char **argv, const char *prefix)
382 printf("git version %s\n", git_version_string);