help.c 9.39 KB
Newer Older
1 2 3
#include "cache.h"
#include "builtin.h"
#include "exec_cmd.h"
4
#include "levenshtein.h"
5
#include "help.h"
6
#include "common-cmds.h"
7

8
/* most GUI terminals set COLUMNS (although some don't export it) */
9 10 11
static int term_columns(void)
{
	char *col_string = getenv("COLUMNS");
12
	int n_cols;
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

	if (col_string && (n_cols = atoi(col_string)) > 0)
		return n_cols;

#ifdef TIOCGWINSZ
	{
		struct winsize ws;
		if (!ioctl(1, TIOCGWINSZ, &ws)) {
			if (ws.ws_col)
				return ws.ws_col;
		}
	}
#endif

	return 80;
}

30
void add_cmdname(struct cmdnames *cmds, const char *name, int len)
31
{
32
	struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1);
33

34 35 36
	ent->len = len;
	memcpy(ent->name, name, len);
	ent->name[len] = 0;
37 38 39

	ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
	cmds->names[cmds->cnt++] = ent;
40 41
}

42 43 44 45 46 47 48 49 50 51
static void clean_cmdnames(struct cmdnames *cmds)
{
	int i;
	for (i = 0; i < cmds->cnt; ++i)
		free(cmds->names[i]);
	free(cmds->names);
	cmds->cnt = 0;
	cmds->alloc = 0;
}

52 53 54 55 56 57 58
static int cmdname_compare(const void *a_, const void *b_)
{
	struct cmdname *a = *(struct cmdname **)a_;
	struct cmdname *b = *(struct cmdname **)b_;
	return strcmp(a->name, b->name);
}

59 60 61 62 63 64 65 66 67 68 69 70 71 72
static void uniq(struct cmdnames *cmds)
{
	int i, j;

	if (!cmds->cnt)
		return;

	for (i = j = 1; i < cmds->cnt; i++)
		if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
			cmds->names[j++] = cmds->names[i];

	cmds->cnt = j;
}

73
void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
74
{
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
	int ci, cj, ei;
	int cmp;

	ci = cj = ei = 0;
	while (ci < cmds->cnt && ei < excludes->cnt) {
		cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
		if (cmp < 0)
			cmds->names[cj++] = cmds->names[ci++];
		else if (cmp == 0)
			ci++, ei++;
		else if (cmp > 0)
			ei++;
	}

	while (ci < cmds->cnt)
		cmds->names[cj++] = cmds->names[ci++];

	cmds->cnt = cj;
}

static void pretty_print_string_list(struct cmdnames *cmds, int longest)
96 97 98 99 100 101 102 103
{
	int cols = 1, rows;
	int space = longest + 1; /* min 1 SP between words */
	int max_cols = term_columns() - 1; /* don't print *on* the edge */
	int i, j;

	if (space < max_cols)
		cols = max_cols / space;
104
	rows = DIV_ROUND_UP(cmds->cnt, cols);
105 106 107 108 109 110 111

	for (i = 0; i < rows; i++) {
		printf("  ");

		for (j = 0; j < cols; j++) {
			int n = j * rows + i;
			int size = space;
112
			if (n >= cmds->cnt)
113
				break;
114
			if (j == cols-1 || n + rows >= cmds->cnt)
115
				size = 1;
116
			printf("%-*s", size, cmds->names[n]->name);
117 118 119 120 121
		}
		putchar('\n');
	}
}

122 123 124 125 126 127 128 129
static int is_executable(const char *name)
{
	struct stat st;

	if (stat(name, &st) || /* stat, not lstat */
	    !S_ISREG(st.st_mode))
		return 0;

130
#ifdef WIN32
李智's avatar
李智 committed
131
{	/* cannot trust the executable bit, peek into the file instead */
132 133 134 135 136 137 138 139 140 141 142 143
	char buf[3] = { 0 };
	int n;
	int fd = open(name, O_RDONLY);
	st.st_mode &= ~S_IXUSR;
	if (fd >= 0) {
		n = read(fd, buf, 2);
		if (n == 2)
			/* DOS executables start with "MZ" */
			if (!strcmp(buf, "#!") || !strcmp(buf, "MZ"))
				st.st_mode |= S_IXUSR;
		close(fd);
	}
李智's avatar
李智 committed
144
}
145 146 147 148
#endif
	return st.st_mode & S_IXUSR;
}

149
static void list_commands_in_dir(struct cmdnames *cmds,
150 151
					 const char *path,
					 const char *prefix)
152
{
153
	int prefix_len;
154
	DIR *dir = opendir(path);
155
	struct dirent *de;
156 157
	struct strbuf buf = STRBUF_INIT;
	int len;
158

159
	if (!dir)
160
		return;
161 162 163
	if (!prefix)
		prefix = "git-";
	prefix_len = strlen(prefix);
164

165 166 167
	strbuf_addf(&buf, "%s/", path);
	len = buf.len;

168 169 170
	while ((de = readdir(dir)) != NULL) {
		int entlen;

171
		if (prefixcmp(de->d_name, prefix))
172
			continue;
173

174 175 176
		strbuf_setlen(&buf, len);
		strbuf_addstr(&buf, de->d_name);
		if (!is_executable(buf.buf))
177 178
			continue;

179
		entlen = strlen(de->d_name) - prefix_len;
180
		if (has_extension(de->d_name, ".exe"))
181 182
			entlen -= 4;

183
		add_cmdname(cmds, de->d_name + prefix_len, entlen);
184 185
	}
	closedir(dir);
186
	strbuf_release(&buf);
187 188
}

189
void load_command_list(const char *prefix,
190 191
		struct cmdnames *main_cmds,
		struct cmdnames *other_cmds)
192 193 194 195
{
	const char *env_path = getenv("PATH");
	const char *exec_path = git_exec_path();

196
	if (exec_path) {
197
		list_commands_in_dir(main_cmds, exec_path, prefix);
198 199 200
		qsort(main_cmds->names, main_cmds->cnt,
		      sizeof(*main_cmds->names), cmdname_compare);
		uniq(main_cmds);
201 202
	}

203 204 205 206 207 208
	if (env_path) {
		char *paths, *path, *colon;
		path = paths = xstrdup(env_path);
		while (1) {
			if ((colon = strchr(path, PATH_SEP)))
				*colon = 0;
209 210
			if (!exec_path || strcmp(path, exec_path))
				list_commands_in_dir(other_cmds, path, prefix);
211

212 213 214 215 216
			if (!colon)
				break;
			path = colon + 1;
		}
		free(paths);
217

218 219 220 221
		qsort(other_cmds->names, other_cmds->cnt,
		      sizeof(*other_cmds->names), cmdname_compare);
		uniq(other_cmds);
	}
222
	exclude_cmds(other_cmds, main_cmds);
Jeff King's avatar
Jeff King committed
223 224
}

225 226
void list_commands(const char *title, struct cmdnames *main_cmds,
		   struct cmdnames *other_cmds)
Jeff King's avatar
Jeff King committed
227
{
228 229 230 231 232 233 234 235
	int i, longest = 0;

	for (i = 0; i < main_cmds->cnt; i++)
		if (longest < main_cmds->names[i]->len)
			longest = main_cmds->names[i]->len;
	for (i = 0; i < other_cmds->cnt; i++)
		if (longest < other_cmds->names[i]->len)
			longest = other_cmds->names[i]->len;
Jeff King's avatar
Jeff King committed
236

237
	if (main_cmds->cnt) {
238
		const char *exec_path = git_exec_path();
239 240 241
		printf("available %s in '%s'\n", title, exec_path);
		printf("----------------");
		mput_char('-', strlen(title) + strlen(exec_path));
242
		putchar('\n');
243
		pretty_print_string_list(main_cmds, longest);
244 245 246
		putchar('\n');
	}

247 248 249 250 251 252
	if (other_cmds->cnt) {
		printf("%s available from elsewhere on your $PATH\n", title);
		printf("---------------------------------------");
		mput_char('-', strlen(title));
		putchar('\n');
		pretty_print_string_list(other_cmds, longest);
253 254
		putchar('\n');
	}
255 256
}

257
int is_in_cmdlist(struct cmdnames *c, const char *s)
Jeff King's avatar
Jeff King committed
258 259 260 261 262 263 264 265
{
	int i;
	for (i = 0; i < c->cnt; i++)
		if (!strcmp(s, c->names[i]->name))
			return 1;
	return 0;
}

266
static int autocorrect;
267
static struct cmdnames aliases;
268 269 270 271 272

static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
{
	if (!strcmp(var, "help.autocorrect"))
		autocorrect = git_config_int(var,value);
273 274 275
	/* Also use aliases for command lookup */
	if (!prefixcmp(var, "alias."))
		add_cmdname(&aliases, var + 6, strlen(var + 6));
276 277 278 279

	return git_default_config(var, value, cb);
}

280
static int levenshtein_compare(const void *p1, const void *p2)
281
{
282 283 284 285 286 287 288
	const struct cmdname *const *c1 = p1, *const *c2 = p2;
	const char *s1 = (*c1)->name, *s2 = (*c2)->name;
	int l1 = (*c1)->len;
	int l2 = (*c2)->len;
	return l1 != l2 ? l1 - l2 : strcmp(s1, s2);
}

289 290 291 292 293 294 295 296 297 298 299 300
static void add_cmd_list(struct cmdnames *cmds, struct cmdnames *old)
{
	int i;
	ALLOC_GROW(cmds->names, cmds->cnt + old->cnt, cmds->alloc);

	for (i = 0; i < old->cnt; i++)
		cmds->names[cmds->cnt++] = old->names[i];
	free(old->names);
	old->cnt = 0;
	old->names = NULL;
}

301
/* An empirically derived magic number */
302 303
#define SIMILARITY_FLOOR 7
#define SIMILAR_ENOUGH(x) ((x) < SIMILARITY_FLOOR)
304

305
const char *help_unknown_cmd(const char *cmd)
306
{
307 308 309 310
	int i, n, best_similarity = 0;
	struct cmdnames main_cmds, other_cmds;

	memset(&main_cmds, 0, sizeof(main_cmds));
311
	memset(&other_cmds, 0, sizeof(other_cmds));
312
	memset(&aliases, 0, sizeof(aliases));
313

314 315
	git_config(git_unknown_cmd_config, NULL);

316 317
	load_command_list("git-", &main_cmds, &other_cmds);

318 319 320 321 322
	add_cmd_list(&main_cmds, &aliases);
	add_cmd_list(&main_cmds, &other_cmds);
	qsort(main_cmds.names, main_cmds.cnt,
	      sizeof(main_cmds.names), cmdname_compare);
	uniq(&main_cmds);
323

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
	/* This abuses cmdname->len for levenshtein distance */
	for (i = 0, n = 0; i < main_cmds.cnt; i++) {
		int cmp = 0; /* avoid compiler stupidity */
		const char *candidate = main_cmds.names[i]->name;

		/* Does the candidate appear in common_cmds list? */
		while (n < ARRAY_SIZE(common_cmds) &&
		       (cmp = strcmp(common_cmds[n].name, candidate)) < 0)
			n++;
		if ((n < ARRAY_SIZE(common_cmds)) && !cmp) {
			/* Yes, this is one of the common commands */
			n++; /* use the entry from common_cmds[] */
			if (!prefixcmp(candidate, cmd)) {
				/* Give prefix match a very good score */
				main_cmds.names[i]->len = 0;
				continue;
			}
		}

343
		main_cmds.names[i]->len =
344 345
			levenshtein(cmd, candidate, 0, 2, 1, 4) + 1;
	}
346 347 348 349 350 351 352

	qsort(main_cmds.names, main_cmds.cnt,
	      sizeof(*main_cmds.names), levenshtein_compare);

	if (!main_cmds.cnt)
		die ("Uh oh. Your system reports no Git commands at all.");

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
	/* skip and count prefix matches */
	for (n = 0; n < main_cmds.cnt && !main_cmds.names[n]->len; n++)
		; /* still counting */

	if (main_cmds.cnt <= n) {
		/* prefix matches with everything? that is too ambiguous */
		best_similarity = SIMILARITY_FLOOR + 1;
	} else {
		/* count all the most similar ones */
		for (best_similarity = main_cmds.names[n++]->len;
		     (n < main_cmds.cnt &&
		      best_similarity == main_cmds.names[n]->len);
		     n++)
			; /* still counting */
	}
368
	if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) {
369 370 371
		const char *assumed = main_cmds.names[0]->name;
		main_cmds.names[0] = NULL;
		clean_cmdnames(&main_cmds);
372
		fprintf(stderr, "WARNING: You called a Git command named '%s', "
373 374 375
			"which does not exist.\n"
			"Continuing under the assumption that you meant '%s'\n",
			cmd, assumed);
376 377 378 379 380
		if (autocorrect > 0) {
			fprintf(stderr, "in %0.1f seconds automatically...\n",
				(float)autocorrect/10.0);
			poll(NULL, 0, autocorrect * 100);
		}
381 382 383
		return assumed;
	}

384
	fprintf(stderr, "git: '%s' is not a git command. See 'git --help'.\n", cmd);
385

386
	if (SIMILAR_ENOUGH(best_similarity)) {
387 388 389 390 391 392 393
		fprintf(stderr, "\nDid you mean %s?\n",
			n < 2 ? "this": "one of these");

		for (i = 0; i < n; i++)
			fprintf(stderr, "\t%s\n", main_cmds.names[i]->name);
	}

394 395 396
	exit(1);
}

397
int cmd_version(int argc, const char **argv, const char *prefix)
398 399 400 401
{
	printf("git version %s\n", git_version_string);
	return 0;
}