4 #include "levenshtein.h"
7 /* most GUI terminals set COLUMNS (although some don't export it) */
8 static int term_columns(void)
10 char *col_string = getenv("COLUMNS");
13 if (col_string && (n_cols = atoi(col_string)) > 0)
19 if (!ioctl(1, TIOCGWINSZ, &ws)) {
29 void add_cmdname(struct cmdnames *cmds, const char *name, int len)
31 struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1);
34 memcpy(ent->name, name, len);
37 ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
38 cmds->names[cmds->cnt++] = ent;
41 static void clean_cmdnames(struct cmdnames *cmds)
44 for (i = 0; i < cmds->cnt; ++i)
51 static int cmdname_compare(const void *a_, const void *b_)
53 struct cmdname *a = *(struct cmdname **)a_;
54 struct cmdname *b = *(struct cmdname **)b_;
55 return strcmp(a->name, b->name);
58 static void uniq(struct cmdnames *cmds)
65 for (i = j = 1; i < cmds->cnt; i++)
66 if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
67 cmds->names[j++] = cmds->names[i];
72 void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
78 while (ci < cmds->cnt && ei < excludes->cnt) {
79 cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
81 cmds->names[cj++] = cmds->names[ci++];
88 while (ci < cmds->cnt)
89 cmds->names[cj++] = cmds->names[ci++];
94 static void pretty_print_string_list(struct cmdnames *cmds, int longest)
97 int space = longest + 1; /* min 1 SP between words */
98 int max_cols = term_columns() - 1; /* don't print *on* the edge */
101 if (space < max_cols)
102 cols = max_cols / space;
103 rows = (cmds->cnt + cols - 1) / cols;
105 for (i = 0; i < rows; i++) {
108 for (j = 0; j < cols; j++) {
109 int n = j * rows + i;
113 if (j == cols-1 || n + rows >= cmds->cnt)
115 printf("%-*s", size, cmds->names[n]->name);
121 static int is_executable(const char *name)
125 if (stat(name, &st) || /* stat, not lstat */
126 !S_ISREG(st.st_mode))
130 /* cannot trust the executable bit, peek into the file instead */
133 int fd = open(name, O_RDONLY);
134 st.st_mode &= ~S_IXUSR;
136 n = read(fd, buf, 2);
138 /* DOS executables start with "MZ" */
139 if (!strcmp(buf, "#!") || !strcmp(buf, "MZ"))
140 st.st_mode |= S_IXUSR;
144 return st.st_mode & S_IXUSR;
147 static unsigned int list_commands_in_dir(struct cmdnames *cmds,
151 unsigned int longest = 0;
153 DIR *dir = opendir(path);
155 struct strbuf buf = STRBUF_INIT;
162 prefix_len = strlen(prefix);
164 strbuf_addf(&buf, "%s/", path);
167 while ((de = readdir(dir)) != NULL) {
170 if (prefixcmp(de->d_name, prefix))
173 strbuf_setlen(&buf, len);
174 strbuf_addstr(&buf, de->d_name);
175 if (!is_executable(buf.buf))
178 entlen = strlen(de->d_name) - prefix_len;
179 if (has_extension(de->d_name, ".exe"))
182 if (longest < entlen)
185 add_cmdname(cmds, de->d_name + prefix_len, entlen);
188 strbuf_release(&buf);
193 unsigned int load_command_list(const char *prefix,
194 struct cmdnames *main_cmds,
195 struct cmdnames *other_cmds)
197 unsigned int longest = 0;
199 const char *env_path = getenv("PATH");
200 char *paths, *path, *colon;
201 const char *exec_path = git_exec_path();
204 longest = list_commands_in_dir(main_cmds, exec_path, prefix);
207 fprintf(stderr, "PATH not set\n");
211 path = paths = xstrdup(env_path);
213 if ((colon = strchr(path, PATH_SEP)))
216 len = list_commands_in_dir(other_cmds, path, prefix);
226 qsort(main_cmds->names, main_cmds->cnt,
227 sizeof(*main_cmds->names), cmdname_compare);
230 qsort(other_cmds->names, other_cmds->cnt,
231 sizeof(*other_cmds->names), cmdname_compare);
233 exclude_cmds(other_cmds, main_cmds);
238 void list_commands(const char *title, unsigned int longest,
239 struct cmdnames *main_cmds, struct cmdnames *other_cmds)
241 const char *exec_path = git_exec_path();
243 if (main_cmds->cnt) {
244 printf("available %s in '%s'\n", title, exec_path);
245 printf("----------------");
246 mput_char('-', strlen(title) + strlen(exec_path));
248 pretty_print_string_list(main_cmds, longest);
252 if (other_cmds->cnt) {
253 printf("%s available from elsewhere on your $PATH\n", title);
254 printf("---------------------------------------");
255 mput_char('-', strlen(title));
257 pretty_print_string_list(other_cmds, longest);
262 int is_in_cmdlist(struct cmdnames *c, const char *s)
265 for (i = 0; i < c->cnt; i++)
266 if (!strcmp(s, c->names[i]->name))
271 static int autocorrect;
273 static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
275 if (!strcmp(var, "help.autocorrect"))
276 autocorrect = git_config_int(var,value);
278 return git_default_config(var, value, cb);
281 static int levenshtein_compare(const void *p1, const void *p2)
283 const struct cmdname *const *c1 = p1, *const *c2 = p2;
284 const char *s1 = (*c1)->name, *s2 = (*c2)->name;
287 return l1 != l2 ? l1 - l2 : strcmp(s1, s2);
290 const char *help_unknown_cmd(const char *cmd)
292 int i, n, best_similarity = 0;
293 struct cmdnames main_cmds, other_cmds;
295 memset(&main_cmds, 0, sizeof(main_cmds));
296 memset(&other_cmds, 0, sizeof(main_cmds));
298 git_config(git_unknown_cmd_config, NULL);
300 load_command_list("git-", &main_cmds, &other_cmds);
302 ALLOC_GROW(main_cmds.names, main_cmds.cnt + other_cmds.cnt,
304 memcpy(main_cmds.names + main_cmds.cnt, other_cmds.names,
305 other_cmds.cnt * sizeof(other_cmds.names[0]));
306 main_cmds.cnt += other_cmds.cnt;
307 free(other_cmds.names);
309 /* This reuses cmdname->len for similarity index */
310 for (i = 0; i < main_cmds.cnt; ++i)
311 main_cmds.names[i]->len =
312 levenshtein(cmd, main_cmds.names[i]->name, 0, 2, 1, 4);
314 qsort(main_cmds.names, main_cmds.cnt,
315 sizeof(*main_cmds.names), levenshtein_compare);
318 die ("Uh oh. Your system reports no Git commands at all.");
320 best_similarity = main_cmds.names[0]->len;
322 while (n < main_cmds.cnt && best_similarity == main_cmds.names[n]->len)
324 if (autocorrect && n == 1) {
325 const char *assumed = main_cmds.names[0]->name;
326 main_cmds.names[0] = NULL;
327 clean_cmdnames(&main_cmds);
328 fprintf(stderr, "WARNING: You called a Git program named '%s', "
329 "which does not exist.\n"
330 "Continuing under the assumption that you meant '%s'\n",
332 if (autocorrect > 0) {
333 fprintf(stderr, "in %0.1f seconds automatically...\n",
334 (float)autocorrect/10.0);
335 poll(NULL, 0, autocorrect * 100);
340 fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
342 if (best_similarity < 6) {
343 fprintf(stderr, "\nDid you mean %s?\n",
344 n < 2 ? "this": "one of these");
346 for (i = 0; i < n; i++)
347 fprintf(stderr, "\t%s\n", main_cmds.names[i]->name);
353 int cmd_version(int argc, const char **argv, const char *prefix)
355 printf("git version %s\n", git_version_string);