[thirdparty/git.git] / builtin-checkout-index.c

/*
 * Check-out files from the "current cache directory"
 *
 * Copyright (C) 2005 Linus Torvalds
 *
 * Careful: order of argument flags does matter. For example,
 *
 *	git checkout-index -a -f file.c
 *
 * Will first check out all files listed in the cache (but not
 * overwrite any old ones), and then force-checkout "file.c" a
 * second time (ie that one _will_ overwrite any old contents
 * with the same filename).
 *
 * Also, just doing "git checkout-index" does nothing. You probably
 * meant "git checkout-index -a". And if you want to force it, you
 * want "git checkout-index -f -a".
 *
 * Intuitiveness is not the goal here. Repeatability is. The
 * reason for the "no arguments means no work" thing is that
 * from scripts you are supposed to be able to do things like
 *
 *	find . -name '*.h' -print0 | xargs -0 git checkout-index -f --
 *
 * or:
 *
 *	find . -name '*.h' -print0 | git checkout-index -f -z --stdin
 *
 * which will force all existing *.h files to be replaced with
 * their cached copies. If an empty command line implied "all",
 * then this would force-refresh everything in the cache, which
 * was not the point.
 *
 * Oh, and the "--" is just a good idea when you know the rest
 * will be filenames. Just so that you wouldn't have a filename
 * of "-a" causing problems (not possible in the above example,
 * but get used to it in scripting!).
 */
#include "builtin.h"
#include "cache.h"
#include "quote.h"
#include "cache-tree.h"
#include "parse-options.h"

#define CHECKOUT_ALL 4
static int line_termination = '\n';
static int checkout_stage; /* default to checkout stage0 */
static int to_tempfile;
static char topath[4][PATH_MAX + 1];

static struct checkout state;

static void write_tempfile_record(const char *name, int prefix_length)
{
	int i;

	if (CHECKOUT_ALL == checkout_stage) {
		for (i = 1; i < 4; i++) {
			if (i > 1)
				putchar(' ');
			if (topath[i][0])
				fputs(topath[i], stdout);
			else
				putchar('.');
		}
	} else
		fputs(topath[checkout_stage], stdout);

	putchar('\t');
	write_name_quoted(name + prefix_length, stdout, line_termination);

	for (i = 0; i < 4; i++) {
		topath[i][0] = 0;
	}
}

static int checkout_file(const char *name, int prefix_length)
{
	int namelen = strlen(name);
	int pos = cache_name_pos(name, namelen);
	int has_same_name = 0;
	int did_checkout = 0;
	int errs = 0;

	if (pos < 0)
		pos = -pos - 1;

	while (pos < active_nr) {
		struct cache_entry *ce = active_cache[pos];
		if (ce_namelen(ce) != namelen ||
		    memcmp(ce->name, name, namelen))
			break;
		has_same_name = 1;
		pos++;
		if (ce_stage(ce) != checkout_stage
		    && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
			continue;
		did_checkout = 1;
		if (checkout_entry(ce, &state,
		    to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
			errs++;
	}

	if (did_checkout) {
		if (to_tempfile)
			write_tempfile_record(name, prefix_length);
		return errs > 0 ? -1 : 0;
	}

	if (!state.quiet) {
		fprintf(stderr, "git checkout-index: %s ", name);
		if (!has_same_name)
			fprintf(stderr, "is not in the cache");
		else if (checkout_stage)
			fprintf(stderr, "does not exist at stage %d",
				checkout_stage);
		else
			fprintf(stderr, "is unmerged");
		fputc('\n', stderr);
	}
	return -1;
}

static void checkout_all(const char *prefix, int prefix_length)
{
	int i, errs = 0;
	struct cache_entry *last_ce = NULL;

	for (i = 0; i < active_nr ; i++) {
		struct cache_entry *ce = active_cache[i];
		if (ce_stage(ce) != checkout_stage
		    && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
			continue;
		if (prefix && *prefix &&
		    (ce_namelen(ce) <= prefix_length ||
		     memcmp(prefix, ce->name, prefix_length)))
			continue;
		if (last_ce && to_tempfile) {
			if (ce_namelen(last_ce) != ce_namelen(ce)
			    || memcmp(last_ce->name, ce->name, ce_namelen(ce)))
				write_tempfile_record(last_ce->name, prefix_length);
		}
		if (checkout_entry(ce, &state,
		    to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
			errs++;
		last_ce = ce;
	}
	if (last_ce && to_tempfile)
		write_tempfile_record(last_ce->name, prefix_length);
	if (errs)
		/* we have already done our error reporting.
		 * exit with the same code as die().
		 */
		exit(128);
}

static const char * const builtin_checkout_index_usage[] = {
	"git checkout-index [options] [--] <file>...",
	NULL
};

static struct lock_file lock_file;

static int option_parse_u(const struct option *opt,
			      const char *arg, int unset)
{
	int *newfd = opt->value;

	state.refresh_cache = 1;
	if (*newfd < 0)
		*newfd = hold_locked_index(&lock_file, 1);
	return 0;
}

static int option_parse_z(const struct option *opt,
			  const char *arg, int unset)
{
	if (unset)
		line_termination = '\n';
	else
		line_termination = 0;
	return 0;
}

static int option_parse_prefix(const struct option *opt,
			       const char *arg, int unset)
{
	state.base_dir = arg;
	state.base_dir_len = strlen(arg);
	return 0;
}

static int option_parse_stage(const struct option *opt,
			      const char *arg, int unset)
{
	if (!strcmp(arg, "all")) {
		to_tempfile = 1;
		checkout_stage = CHECKOUT_ALL;
	} else {
		int ch = arg[0];
		if ('1' <= ch && ch <= '3')
			checkout_stage = arg[0] - '0';
		else
			die("stage should be between 1 and 3 or all");
	}
	return 0;
}

int cmd_checkout_index(int argc, const char **argv, const char *prefix)
{
	int i;
	int newfd = -1;
	int all = 0;
	int read_from_stdin = 0;
	int prefix_length;
	int force = 0, quiet = 0, not_new = 0;
	struct option builtin_checkout_index_options[] = {
		OPT_BOOLEAN('a', "all", &all,
			"checks out all files in the index"),
		OPT_BOOLEAN('f', "force", &force,
			"forces overwrite of existing files"),
		OPT__QUIET(&quiet),
		OPT_BOOLEAN('n', "no-create", &not_new,
			"don't checkout new files"),
		{ OPTION_CALLBACK, 'u', "index", &newfd, NULL,
			"update stat information in the index file",
			PARSE_OPT_NOARG, option_parse_u },
		{ OPTION_CALLBACK, 'z', NULL, NULL, NULL,
			"paths are separated with NUL character",
			PARSE_OPT_NOARG, option_parse_z },
		OPT_BOOLEAN(0, "stdin", &read_from_stdin,
			"read list of paths from the standard input"),
		OPT_BOOLEAN(0, "temp", &to_tempfile,
			"write the content to temporary files"),
		OPT_CALLBACK(0, "prefix", NULL, "string",
			"when creating files, prepend <string>",
			option_parse_prefix),
		OPT_CALLBACK(0, "stage", NULL, NULL,
			"copy out the files from named stage",
			option_parse_stage),
		OPT_END()
	};

	git_config(git_default_config, NULL);
	state.base_dir = "";
	prefix_length = prefix ? strlen(prefix) : 0;

	if (read_cache() < 0) {
		die("invalid cache");
	}

	argc = parse_options(argc, argv, prefix, builtin_checkout_index_options,
			builtin_checkout_index_usage, 0);
	state.force = force;
	state.quiet = quiet;
	state.not_new = not_new;

	if (state.base_dir_len || to_tempfile) {
		/* when --prefix is specified we do not
		 * want to update cache.
		 */
		if (state.refresh_cache) {
			rollback_lock_file(&lock_file);
			newfd = -1;
		}
		state.refresh_cache = 0;
	}

	/* Check out named files first */
	for (i = 0; i < argc; i++) {
		const char *arg = argv[i];
		const char *p;

		if (all)
			die("git checkout-index: don't mix '--all' and explicit filenames");
		if (read_from_stdin)
			die("git checkout-index: don't mix '--stdin' and explicit filenames");
		p = prefix_path(prefix, prefix_length, arg);
		checkout_file(p, prefix_length);
		if (p < arg || p > arg + strlen(arg))
			free((char *)p);
	}

	if (read_from_stdin) {
		struct strbuf buf = STRBUF_INIT, nbuf = STRBUF_INIT;

		if (all)
			die("git checkout-index: don't mix '--all' and '--stdin'");

		while (strbuf_getline(&buf, stdin, line_termination) != EOF) {
			const char *p;
			if (line_termination && buf.buf[0] == '"') {
				strbuf_reset(&nbuf);
				if (unquote_c_style(&nbuf, buf.buf, NULL))
					die("line is badly quoted");
				strbuf_swap(&buf, &nbuf);
			}
			p = prefix_path(prefix, prefix_length, buf.buf);
			checkout_file(p, prefix_length);
			if (p < buf.buf || p > buf.buf + buf.len)
				free((char *)p);
		}
		strbuf_release(&nbuf);
		strbuf_release(&buf);
	}

	if (all)
		checkout_all(prefix, prefix_length);

	if (0 <= newfd &&
	    (write_cache(newfd, active_cache, active_nr) ||
	     commit_locked_index(&lock_file)))
		die("Unable to write new index file");
	return 0;
}
Commit	Line	Data
33db5f4d LT	1	/*
	2	* Check-out files from the "current cache directory"
	3	*
	4	* Copyright (C) 2005 Linus Torvalds
	5	*
	6	* Careful: order of argument flags does matter. For example,
	7	*
05207a28	8	* git checkout-index -a -f file.c
33db5f4d LT	9	*
	10	* Will first check out all files listed in the cache (but not
	11	* overwrite any old ones), and then force-checkout "file.c" a
	12	* second time (ie that one _will_ overwrite any old contents
	13	* with the same filename).
	14	*
05207a28 HO	15	* Also, just doing "git checkout-index" does nothing. You probably
	16	* meant "git checkout-index -a". And if you want to force it, you
	17	* want "git checkout-index -f -a".
33db5f4d LT	18	*
	19	* Intuitiveness is not the goal here. Repeatability is. The
	20	* reason for the "no arguments means no work" thing is that
	21	* from scripts you are supposed to be able to do things like
	22	*
05207a28	23	* find . -name '*.h' -print0 \| xargs -0 git checkout-index -f --
33db5f4d	24	*
9debe63d SP	25	* or:
9debe63d SP	26	*
05207a28	27	* find . -name '*.h' -print0 \| git checkout-index -f -z --stdin
9debe63d	28	*
33db5f4d LT	29	* which will force all existing *.h files to be replaced with
	30	* their cached copies. If an empty command line implied "all",
	31	* then this would force-refresh everything in the cache, which
	32	* was not the point.
	33	*
	34	* Oh, and the "--" is just a good idea when you know the rest
	35	* will be filenames. Just so that you wouldn't have a filename
	36	* of "-a" causing problems (not possible in the above example,
	37	* but get used to it in scripting!).
	38	*/
baffc0e7	39	#include "builtin.h"
33db5f4d	40	#include "cache.h"
9debe63d	41	#include "quote.h"
bad68ec9	42	#include "cache-tree.h"
a6c7db1b	43	#include "parse-options.h"
33db5f4d	44
de84f99c	45	#define CHECKOUT_ALL 4
de84f99c	46	static int line_termination = '\n';
3bd348ae	47	static int checkout_stage; /* default to checkout stage0 */
de84f99c	48	static int to_tempfile;
095c424d	49	static char topath[4][PATH_MAX + 1];
c3e9a653	50
344c52ae	51	static struct checkout state;
33db5f4d	52
e414156a	53	static void write_tempfile_record(const char *name, int prefix_length)
de84f99c SP	54	{
	55	int i;
	56
	57	if (CHECKOUT_ALL == checkout_stage) {
	58	for (i = 1; i < 4; i++) {
	59	if (i > 1)
	60	putchar(' ');
	61	if (topath[i][0])
	62	fputs(topath[i], stdout);
	63	else
	64	putchar('.');
	65	}
	66	} else
	67	fputs(topath[checkout_stage], stdout);
	68
	69	putchar('\t');
663af342	70	write_name_quoted(name + prefix_length, stdout, line_termination);
de84f99c SP	71
	72	for (i = 0; i < 4; i++) {
	73	topath[i][0] = 0;
	74	}
	75	}
	76
e414156a	77	static int checkout_file(const char *name, int prefix_length)
33db5f4d	78	{
3bd348ae JH	79	int namelen = strlen(name);
	80	int pos = cache_name_pos(name, namelen);
	81	int has_same_name = 0;
de84f99c SP	82	int did_checkout = 0;
de84f99c SP	83	int errs = 0;
3bd348ae JH	84
	85	if (pos < 0)
	86	pos = -pos - 1;
	87
	88	while (pos < active_nr) {
	89	struct cache_entry *ce = active_cache[pos];
f4f9adae	90	if (ce_namelen(ce) != namelen \|\|
3bd348ae JH	91	memcmp(ce->name, name, namelen))
	92	break;
	93	has_same_name = 1;
3bd348ae	94	pos++;
de84f99c SP	95	if (ce_stage(ce) != checkout_stage
	96	&& (CHECKOUT_ALL != checkout_stage \|\| !ce_stage(ce)))
	97	continue;
	98	did_checkout = 1;
	99	if (checkout_entry(ce, &state,
	100	to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
	101	errs++;
	102	}
	103
	104	if (did_checkout) {
	105	if (to_tempfile)
e414156a	106	write_tempfile_record(name, prefix_length);
de84f99c	107	return errs > 0 ? -1 : 0;
33db5f4d	108	}
3bd348ae JH	109
3bd348ae JH	110	if (!state.quiet) {
05207a28	111	fprintf(stderr, "git checkout-index: %s ", name);
3bd348ae JH	112	if (!has_same_name)
	113	fprintf(stderr, "is not in the cache");
	114	else if (checkout_stage)
	115	fprintf(stderr, "does not exist at stage %d",
	116	checkout_stage);
	117	else
	118	fprintf(stderr, "is unmerged");
	119	fputc('\n', stderr);
	120	}
	121	return -1;
33db5f4d LT	122	}
33db5f4d LT	123
f7f0fbfc	124	static void checkout_all(const char *prefix, int prefix_length)
33db5f4d	125	{
4b12dae6	126	int i, errs = 0;
4b25d091	127	struct cache_entry *last_ce = NULL;
33db5f4d LT	128
	129	for (i = 0; i < active_nr ; i++) {
	130	struct cache_entry *ce = active_cache[i];
de84f99c SP	131	if (ce_stage(ce) != checkout_stage
de84f99c SP	132	&& (CHECKOUT_ALL != checkout_stage \|\| !ce_stage(ce)))
d9f98eeb	133	continue;
c3e9a653	134	if (prefix && *prefix &&
3bd348ae JH	135	(ce_namelen(ce) <= prefix_length \|\|
3bd348ae JH	136	memcmp(prefix, ce->name, prefix_length)))
c3e9a653	137	continue;
de84f99c SP	138	if (last_ce && to_tempfile) {
	139	if (ce_namelen(last_ce) != ce_namelen(ce)
	140	\|\| memcmp(last_ce->name, ce->name, ce_namelen(ce)))
e414156a	141	write_tempfile_record(last_ce->name, prefix_length);
de84f99c SP	142	}
	143	if (checkout_entry(ce, &state,
	144	to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
4b12dae6	145	errs++;
de84f99c	146	last_ce = ce;
33db5f4d	147	}
de84f99c	148	if (last_ce && to_tempfile)
e414156a	149	write_tempfile_record(last_ce->name, prefix_length);
4b12dae6 JH	150	if (errs)
	151	/* we have already done our error reporting.
	152	* exit with the same code as die().
	153	*/
	154	exit(128);
33db5f4d LT	155	}
33db5f4d LT	156
a6c7db1b MV	157	static const char * const builtin_checkout_index_usage[] = {
	158	"git checkout-index [options] [--] <file>...",
	159	NULL
	160	};
d46ad9c9	161
021b6e45	162	static struct lock_file lock_file;
31f584c2	163
a6c7db1b MV	164	static int option_parse_u(const struct option *opt,
	165	const char *arg, int unset)
	166	{
	167	int *newfd = opt->value;
	168
	169	state.refresh_cache = 1;
	170	if (*newfd < 0)
	171	*newfd = hold_locked_index(&lock_file, 1);
	172	return 0;
	173	}
	174
	175	static int option_parse_z(const struct option *opt,
	176	const char *arg, int unset)
	177	{
	178	if (unset)
	179	line_termination = '\n';
	180	else
	181	line_termination = 0;
	182	return 0;
	183	}
	184
	185	static int option_parse_prefix(const struct option *opt,
	186	const char *arg, int unset)
	187	{
	188	state.base_dir = arg;
	189	state.base_dir_len = strlen(arg);
	190	return 0;
	191	}
	192
	193	static int option_parse_stage(const struct option *opt,
	194	const char *arg, int unset)
	195	{
	196	if (!strcmp(arg, "all")) {
	197	to_tempfile = 1;
	198	checkout_stage = CHECKOUT_ALL;
	199	} else {
	200	int ch = arg[0];
	201	if ('1' <= ch && ch <= '3')
	202	checkout_stage = arg[0] - '0';
	203	else
	204	die("stage should be between 1 and 3 or all");
	205	}
	206	return 0;
	207	}
	208
e414156a	209	int cmd_checkout_index(int argc, const char *argv, const char prefix)
33db5f4d	210	{
a65a686f	211	int i;
415e96c8	212	int newfd = -1;
a65a686f	213	int all = 0;
9debe63d	214	int read_from_stdin = 0;
e414156a	215	int prefix_length;
a6c7db1b MV	216	int force = 0, quiet = 0, not_new = 0;
	217	struct option builtin_checkout_index_options[] = {
	218	OPT_BOOLEAN('a', "all", &all,
	219	"checks out all files in the index"),
	220	OPT_BOOLEAN('f', "force", &force,
	221	"forces overwrite of existing files"),
	222	OPT__QUIET(&quiet),
	223	OPT_BOOLEAN('n', "no-create", &not_new,
	224	"don't checkout new files"),
	225	{ OPTION_CALLBACK, 'u', "index", &newfd, NULL,
	226	"update stat information in the index file",
	227	PARSE_OPT_NOARG, option_parse_u },
	228	{ OPTION_CALLBACK, 'z', NULL, NULL, NULL,
	229	"paths are separated with NUL character",
	230	PARSE_OPT_NOARG, option_parse_z },
	231	OPT_BOOLEAN(0, "stdin", &read_from_stdin,
	232	"read list of paths from the standard input"),
	233	OPT_BOOLEAN(0, "temp", &to_tempfile,
	234	"write the content to temporary files"),
	235	OPT_CALLBACK(0, "prefix", NULL, "string",
	236	"when creating files, prepend <string>",
	237	option_parse_prefix),
	238	OPT_CALLBACK(0, "stage", NULL, NULL,
	239	"copy out the files from named stage",
	240	option_parse_stage),
	241	OPT_END()
	242	};
33db5f4d	243
ef90d6d4	244	git_config(git_default_config, NULL);
e414156a	245	state.base_dir = "";
c3e9a653 JH	246	prefix_length = prefix ? strlen(prefix) : 0;
c3e9a653 JH	247
33db5f4d	248	if (read_cache() < 0) {
2de381f9	249	die("invalid cache");
33db5f4d LT	250	}
33db5f4d LT	251
37782920	252	argc = parse_options(argc, argv, prefix, builtin_checkout_index_options,
a6c7db1b MV	253	builtin_checkout_index_usage, 0);
	254	state.force = force;
	255	state.quiet = quiet;
	256	state.not_new = not_new;
a65a686f	257
de84f99c	258	if (state.base_dir_len \|\| to_tempfile) {
a65a686f LT	259	/* when --prefix is specified we do not
	260	* want to update cache.
	261	*/
	262	if (state.refresh_cache) {
021b6e45	263	rollback_lock_file(&lock_file);
4ed7cd3a	264	newfd = -1;
a65a686f LT	265	}
	266	state.refresh_cache = 0;
	267	}
	268
	269	/* Check out named files first */
a6c7db1b	270	for (i = 0; i < argc; i++) {
a65a686f	271	const char *arg = argv[i];
dc46da22	272	const char *p;
a65a686f LT	273
a65a686f LT	274	if (all)
7e44c935	275	die("git checkout-index: don't mix '--all' and explicit filenames");
9debe63d	276	if (read_from_stdin)
7e44c935	277	die("git checkout-index: don't mix '--stdin' and explicit filenames");
dc46da22	278	p = prefix_path(prefix, prefix_length, arg);
e414156a	279	checkout_file(p, prefix_length);
be65e7d9	280	if (p < arg \|\| p > arg + strlen(arg))
4b25d091	281	free((char *)p);
33db5f4d	282	}
415e96c8	283
9debe63d	284	if (read_from_stdin) {
f285a2d7	285	struct strbuf buf = STRBUF_INIT, nbuf = STRBUF_INIT;
7fb1011e	286
9debe63d	287	if (all)
7e44c935	288	die("git checkout-index: don't mix '--all' and '--stdin'");
7fb1011e	289
7fb1011e	290	while (strbuf_getline(&buf, stdin, line_termination) != EOF) {
dc46da22	291	const char *p;
7fb1011e PH	292	if (line_termination && buf.buf[0] == '"') {
	293	strbuf_reset(&nbuf);
	294	if (unquote_c_style(&nbuf, buf.buf, NULL))
	295	die("line is badly quoted");
	296	strbuf_swap(&buf, &nbuf);
	297	}
	298	p = prefix_path(prefix, prefix_length, buf.buf);
e414156a	299	checkout_file(p, prefix_length);
7fb1011e	300	if (p < buf.buf \|\| p > buf.buf + buf.len)
dc46da22	301	free((char *)p);
9debe63d	302	}
7fb1011e	303	strbuf_release(&nbuf);
e6c019d0	304	strbuf_release(&buf);
9debe63d SP	305	}
9debe63d SP	306
a65a686f	307	if (all)
e414156a	308	checkout_all(prefix, prefix_length);
a65a686f	309
415e96c8 JH	310	if (0 <= newfd &&
415e96c8 JH	311	(write_cache(newfd, active_cache, active_nr) \|\|
4ed7cd3a	312	commit_locked_index(&lock_file)))
021b6e45	313	die("Unable to write new index file");
33db5f4d LT	314	return 0;
33db5f4d LT	315	}