4 #include "levenshtein.h"
6 #include "common-cmds.h"
7 #include "string-list.h"
12 void add_cmdname(struct cmdnames *cmds, const char *name, int len)
14 struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1);
17 memcpy(ent->name, name, len);
20 ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
21 cmds->names[cmds->cnt++] = ent;
24 static void clean_cmdnames(struct cmdnames *cmds)
27 for (i = 0; i < cmds->cnt; ++i)
34 static int cmdname_compare(const void *a_, const void *b_)
36 struct cmdname *a = *(struct cmdname **)a_;
37 struct cmdname *b = *(struct cmdname **)b_;
38 return strcmp(a->name, b->name);
41 static void uniq(struct cmdnames *cmds)
48 for (i = j = 1; i < cmds->cnt; i++) {
49 if (!strcmp(cmds->names[i]->name, cmds->names[j-1]->name))
52 cmds->names[j++] = cmds->names[i];
58 void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
64 while (ci < cmds->cnt && ei < excludes->cnt) {
65 cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
67 cmds->names[cj++] = cmds->names[ci++];
70 free(cmds->names[ci++]);
75 while (ci < cmds->cnt)
76 cmds->names[cj++] = cmds->names[ci++];
81 static void pretty_print_cmdnames(struct cmdnames *cmds, unsigned int colopts)
83 struct string_list list = STRING_LIST_INIT_NODUP;
84 struct column_options copts;
87 for (i = 0; i < cmds->cnt; i++)
88 string_list_append(&list, cmds->names[i]->name);
90 * always enable column display, we only consult column.*
91 * about layout strategy and stuff
93 colopts = (colopts & ~COL_ENABLE_MASK) | COL_ENABLED;
94 memset(&copts, 0, sizeof(copts));
97 print_columns(&list, colopts, &copts);
98 string_list_clear(&list, 0);
101 static int is_executable(const char *name)
105 if (stat(name, &st) || /* stat, not lstat */
106 !S_ISREG(st.st_mode))
109 #if defined(GIT_WINDOWS_NATIVE)
110 { /* cannot trust the executable bit, peek into the file instead */
113 int fd = open(name, O_RDONLY);
114 st.st_mode &= ~S_IXUSR;
116 n = read(fd, buf, 2);
118 /* DOS executables start with "MZ" */
119 if (!strcmp(buf, "#!") || !strcmp(buf, "MZ"))
120 st.st_mode |= S_IXUSR;
125 return st.st_mode & S_IXUSR;
128 static void list_commands_in_dir(struct cmdnames *cmds,
133 DIR *dir = opendir(path);
135 struct strbuf buf = STRBUF_INIT;
142 prefix_len = strlen(prefix);
144 strbuf_addf(&buf, "%s/", path);
147 while ((de = readdir(dir)) != NULL) {
150 if (!starts_with(de->d_name, prefix))
153 strbuf_setlen(&buf, len);
154 strbuf_addstr(&buf, de->d_name);
155 if (!is_executable(buf.buf))
158 entlen = strlen(de->d_name) - prefix_len;
159 if (has_extension(de->d_name, ".exe"))
162 add_cmdname(cmds, de->d_name + prefix_len, entlen);
165 strbuf_release(&buf);
168 void load_command_list(const char *prefix,
169 struct cmdnames *main_cmds,
170 struct cmdnames *other_cmds)
172 const char *env_path = getenv("PATH");
173 const char *exec_path = git_exec_path();
176 list_commands_in_dir(main_cmds, exec_path, prefix);
177 qsort(main_cmds->names, main_cmds->cnt,
178 sizeof(*main_cmds->names), cmdname_compare);
183 char *paths, *path, *colon;
184 path = paths = xstrdup(env_path);
186 if ((colon = strchr(path, PATH_SEP)))
188 if (!exec_path || strcmp(path, exec_path))
189 list_commands_in_dir(other_cmds, path, prefix);
197 qsort(other_cmds->names, other_cmds->cnt,
198 sizeof(*other_cmds->names), cmdname_compare);
201 exclude_cmds(other_cmds, main_cmds);
204 void list_commands(unsigned int colopts,
205 struct cmdnames *main_cmds, struct cmdnames *other_cmds)
207 if (main_cmds->cnt) {
208 const char *exec_path = git_exec_path();
209 printf_ln(_("available git commands in '%s'"), exec_path);
211 pretty_print_cmdnames(main_cmds, colopts);
215 if (other_cmds->cnt) {
216 printf_ln(_("git commands available from elsewhere on your $PATH"));
218 pretty_print_cmdnames(other_cmds, colopts);
223 void list_common_cmds_help(void)
227 for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
228 if (longest < strlen(common_cmds[i].name))
229 longest = strlen(common_cmds[i].name);
232 puts(_("The most commonly used git commands are:"));
233 for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
234 printf(" %s ", common_cmds[i].name);
235 mput_char(' ', longest - strlen(common_cmds[i].name));
236 puts(_(common_cmds[i].help));
240 int is_in_cmdlist(struct cmdnames *c, const char *s)
243 for (i = 0; i < c->cnt; i++)
244 if (!strcmp(s, c->names[i]->name))
249 static int autocorrect;
250 static struct cmdnames aliases;
252 static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
256 if (!strcmp(var, "help.autocorrect"))
257 autocorrect = git_config_int(var,value);
258 /* Also use aliases for command lookup */
259 if (skip_prefix(var, "alias.", &p))
260 add_cmdname(&aliases, p, strlen(p));
262 return git_default_config(var, value, cb);
265 static int levenshtein_compare(const void *p1, const void *p2)
267 const struct cmdname *const *c1 = p1, *const *c2 = p2;
268 const char *s1 = (*c1)->name, *s2 = (*c2)->name;
271 return l1 != l2 ? l1 - l2 : strcmp(s1, s2);
274 static void add_cmd_list(struct cmdnames *cmds, struct cmdnames *old)
277 ALLOC_GROW(cmds->names, cmds->cnt + old->cnt, cmds->alloc);
279 for (i = 0; i < old->cnt; i++)
280 cmds->names[cmds->cnt++] = old->names[i];
286 /* An empirically derived magic number */
287 #define SIMILARITY_FLOOR 7
288 #define SIMILAR_ENOUGH(x) ((x) < SIMILARITY_FLOOR)
290 static const char bad_interpreter_advice[] =
291 N_("'%s' appears to be a git command, but we were not\n"
292 "able to execute it. Maybe git-%s is broken?");
294 const char *help_unknown_cmd(const char *cmd)
296 int i, n, best_similarity = 0;
297 struct cmdnames main_cmds, other_cmds;
299 memset(&main_cmds, 0, sizeof(main_cmds));
300 memset(&other_cmds, 0, sizeof(other_cmds));
301 memset(&aliases, 0, sizeof(aliases));
303 git_config(git_unknown_cmd_config, NULL);
305 load_command_list("git-", &main_cmds, &other_cmds);
307 add_cmd_list(&main_cmds, &aliases);
308 add_cmd_list(&main_cmds, &other_cmds);
309 qsort(main_cmds.names, main_cmds.cnt,
310 sizeof(main_cmds.names), cmdname_compare);
313 /* This abuses cmdname->len for levenshtein distance */
314 for (i = 0, n = 0; i < main_cmds.cnt; i++) {
315 int cmp = 0; /* avoid compiler stupidity */
316 const char *candidate = main_cmds.names[i]->name;
319 * An exact match means we have the command, but
320 * for some reason exec'ing it gave us ENOENT; probably
321 * it's a bad interpreter in the #! line.
323 if (!strcmp(candidate, cmd))
324 die(_(bad_interpreter_advice), cmd, cmd);
326 /* Does the candidate appear in common_cmds list? */
327 while (n < ARRAY_SIZE(common_cmds) &&
328 (cmp = strcmp(common_cmds[n].name, candidate)) < 0)
330 if ((n < ARRAY_SIZE(common_cmds)) && !cmp) {
331 /* Yes, this is one of the common commands */
332 n++; /* use the entry from common_cmds[] */
333 if (starts_with(candidate, cmd)) {
334 /* Give prefix match a very good score */
335 main_cmds.names[i]->len = 0;
340 main_cmds.names[i]->len =
341 levenshtein(cmd, candidate, 0, 2, 1, 3) + 1;
344 qsort(main_cmds.names, main_cmds.cnt,
345 sizeof(*main_cmds.names), levenshtein_compare);
348 die(_("Uh oh. Your system reports no Git commands at all."));
350 /* skip and count prefix matches */
351 for (n = 0; n < main_cmds.cnt && !main_cmds.names[n]->len; n++)
352 ; /* still counting */
354 if (main_cmds.cnt <= n) {
355 /* prefix matches with everything? that is too ambiguous */
356 best_similarity = SIMILARITY_FLOOR + 1;
358 /* count all the most similar ones */
359 for (best_similarity = main_cmds.names[n++]->len;
360 (n < main_cmds.cnt &&
361 best_similarity == main_cmds.names[n]->len);
363 ; /* still counting */
365 if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) {
366 const char *assumed = main_cmds.names[0]->name;
367 main_cmds.names[0] = NULL;
368 clean_cmdnames(&main_cmds);
370 _("WARNING: You called a Git command named '%s', "
371 "which does not exist.\n"
372 "Continuing under the assumption that you meant '%s'"),
374 if (autocorrect > 0) {
375 fprintf_ln(stderr, _("in %0.1f seconds automatically..."),
376 (float)autocorrect/10.0);
377 poll(NULL, 0, autocorrect * 100);
382 fprintf_ln(stderr, _("git: '%s' is not a git command. See 'git --help'."), cmd);
384 if (SIMILAR_ENOUGH(best_similarity)) {
386 Q_("\nDid you mean this?",
387 "\nDid you mean one of these?",
390 for (i = 0; i < n; i++)
391 fprintf(stderr, "\t%s\n", main_cmds.names[i]->name);
397 int cmd_version(int argc, const char **argv, const char *prefix)
400 * The format of this string should be kept stable for compatibility
401 * with external projects that rely on the output of "git version".
403 printf("git version %s\n", git_version_string);
407 struct similar_ref_cb {
408 const char *base_ref;
409 struct string_list *similar_refs;
412 static int append_similar_ref(const char *refname, const unsigned char *sha1,
413 int flags, void *cb_data)
415 struct similar_ref_cb *cb = (struct similar_ref_cb *)(cb_data);
416 char *branch = strrchr(refname, '/') + 1;
419 /* A remote branch of the same name is deemed similar */
420 if (skip_prefix(refname, "refs/remotes/", &remote) &&
421 !strcmp(branch, cb->base_ref))
422 string_list_append(cb->similar_refs, remote);
426 static struct string_list guess_refs(const char *ref)
428 struct similar_ref_cb ref_cb;
429 struct string_list similar_refs = STRING_LIST_INIT_NODUP;
431 ref_cb.base_ref = ref;
432 ref_cb.similar_refs = &similar_refs;
433 for_each_ref(append_similar_ref, &ref_cb);
437 void help_unknown_ref(const char *ref, const char *cmd, const char *error)
440 struct string_list suggested_refs = guess_refs(ref);
442 fprintf_ln(stderr, _("%s: %s - %s"), cmd, ref, error);
444 if (suggested_refs.nr > 0) {
446 Q_("\nDid you mean this?",
447 "\nDid you mean one of these?",
449 for (i = 0; i < suggested_refs.nr; i++)
450 fprintf(stderr, "\t%s\n", suggested_refs.items[i].string);
453 string_list_clear(&suggested_refs, 0);