Commit ea9e2c1a4a16b572a3621d9bd7b1383365701b9e

Patrick Steinhardt 2018-07-20T13:06:56

Merge pull request #4692 from tiennou/examples/checkout Add a checkout example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
diff --git a/examples/checkout.c b/examples/checkout.c
new file mode 100644
index 0000000..f92ad73
--- /dev/null
+++ b/examples/checkout.c
@@ -0,0 +1,235 @@
+/*
+ * libgit2 "checkout" example - shows how to perform checkouts
+ *
+ * Written by the libgit2 contributors
+ *
+ * To the extent possible under law, the author(s) have dedicated all copyright
+ * and related and neighboring rights to this software to the public domain
+ * worldwide. This software is distributed without any warranty.
+ *
+ * You should have received a copy of the CC0 Public Domain Dedication along
+ * with this software. If not, see
+ * <http://creativecommons.org/publicdomain/zero/1.0/>.
+ */
+
+#include "common.h"
+#include <assert.h>
+
+/* Define the printf format specifer to use for size_t output */
+#if defined(_MSC_VER) || defined(__MINGW32__)
+#	define PRIuZ "Iu"
+#	define PRIxZ "Ix"
+#	define PRIdZ "Id"
+#else
+#	define PRIuZ "zu"
+#	define PRIxZ "zx"
+#	define PRIdZ "zd"
+#endif
+
+/**
+ * The following example demonstrates how to do checkouts with libgit2.
+ *
+ * Recognized options are :
+ *  --force: force the checkout to happen.
+ *  --[no-]progress: show checkout progress, on by default.
+ *  --perf: show performance data.
+ */
+
+typedef struct {
+	int force : 1;
+	int progress : 1;
+	int perf : 1;
+} checkout_options;
+
+static void print_usage(void)
+{
+	fprintf(stderr, "usage: checkout [options] <branch>\n"
+		"Options are :\n"
+		"  --git-dir: use the following git repository.\n"
+		"  --force: force the checkout.\n"
+		"  --[no-]progress: show checkout progress.\n"
+		"  --perf: show performance data.\n");
+	exit(1);
+}
+
+static void parse_options(const char **repo_path, checkout_options *opts, struct args_info *args)
+{
+	if (args->argc <= 1)
+		print_usage();
+
+	memset(opts, 0, sizeof(*opts));
+
+	/* Default values */
+	opts->progress = 1;
+
+	for (args->pos = 1; args->pos < args->argc; ++args->pos) {
+		const char *curr = args->argv[args->pos];
+		int bool_arg;
+
+		if (strcmp(curr, "--") == 0) {
+			break;
+		} else if (!strcmp(curr, "--force")) {
+			opts->force = 1;
+		} else if (match_bool_arg(&bool_arg, args, "--progress")) {
+			opts->progress = bool_arg;
+		} else if (match_bool_arg(&bool_arg, args, "--perf")) {
+			opts->perf = bool_arg;
+		} else if (match_str_arg(repo_path, args, "--git-dir")) {
+			continue;
+		} else {
+			break;
+		}
+	}
+}
+
+/**
+ * This function is called to report progression, ie. it's called once with
+ * a NULL path and the number of total steps, then for each subsequent path,
+ * the current completed_step value.
+ */
+static void print_checkout_progress(const char *path, size_t completed_steps, size_t total_steps, void *payload)
+{
+	(void)payload;
+	if (path == NULL) {
+		printf("checkout started: %" PRIuZ " steps\n", total_steps);
+	} else {
+		printf("checkout: %s %" PRIuZ "/%" PRIuZ "\n", path, completed_steps, total_steps);
+	}
+}
+
+/**
+ * This function is called when the checkout completes, and is used to report the
+ * number of syscalls performed.
+ */
+static void print_perf_data(const git_checkout_perfdata *perfdata, void *payload)
+{
+	(void)payload;
+	printf("perf: stat: %" PRIuZ " mkdir: %" PRIuZ " chmod: %" PRIuZ "\n",
+	       perfdata->stat_calls, perfdata->mkdir_calls, perfdata->chmod_calls);
+}
+
+/**
+ * This is the main "checkout <branch>" function, responsible for performing
+ * a branch-based checkout.
+ */
+static int perform_checkout_ref(git_repository *repo, git_annotated_commit *target, checkout_options *opts)
+{
+	git_checkout_options checkout_opts = GIT_CHECKOUT_OPTIONS_INIT;
+	git_commit *target_commit = NULL;
+	int err;
+
+	/** Setup our checkout options from the parsed options */
+	checkout_opts.checkout_strategy = GIT_CHECKOUT_SAFE;
+	if (opts->force)
+		checkout_opts.checkout_strategy = GIT_CHECKOUT_FORCE;
+
+	if (opts->progress)
+		checkout_opts.progress_cb = print_checkout_progress;
+
+	if (opts->perf)
+		checkout_opts.perfdata_cb = print_perf_data;
+
+	/** Grab the commit we're interested to move to */
+	err = git_commit_lookup(&target_commit, repo, git_annotated_commit_id(target));
+	if (err != 0) {
+		fprintf(stderr, "failed to lookup commit: %s\n", giterr_last()->message);
+		goto cleanup;
+	}
+
+	/**
+	 * Perform the checkout so the workdir corresponds to what target_commit
+	 * contains.
+	 *
+	 * Note that it's okay to pass a git_commit here, because it will be 
+	 * peeled to a tree.
+	 */
+	err = git_checkout_tree(repo, (const git_object *)target_commit, &checkout_opts);
+	if (err != 0) {
+		fprintf(stderr, "failed to checkout tree: %s\n", giterr_last()->message);
+		goto cleanup;
+	}
+
+	/**
+	 * Now that the checkout has completed, we have to update HEAD.
+	 *
+	 * Depending on the "origin" of target (ie. it's an OID or a branch name),
+	 * we might need to detach HEAD.
+	 */
+	if (git_annotated_commit_ref(target)) {
+		err = git_repository_set_head(repo, git_annotated_commit_ref(target));
+	} else {
+		err = git_repository_set_head_detached_from_annotated(repo, target);
+	}
+	if (err != 0) {
+		fprintf(stderr, "failed to update HEAD reference: %s\n", giterr_last()->message);
+		goto cleanup;
+	}
+
+cleanup:
+	git_commit_free(target_commit);
+
+	return err;
+}
+
+/** That example's entry point */
+int main(int argc, char **argv)
+{
+	git_repository *repo = NULL;
+	struct args_info args = ARGS_INFO_INIT;
+	checkout_options opts;
+	git_repository_state_t state;
+	git_annotated_commit *checkout_target = NULL;
+	int err = 0;
+	const char *path = ".";
+
+	/** Parse our command line options */
+	parse_options(&path, &opts, &args);
+
+	/** Initialize the library */
+	err = git_libgit2_init();
+	if (!err)
+		check_lg2(err, "Failed to initialize libgit2", NULL);
+
+	/** Open the repository corresponding to the options */
+	check_lg2(git_repository_open_ext(&repo, path, 0, NULL),
+			  "Could not open repository", NULL);
+
+	/** Make sure we're not about to checkout while something else is going on */
+	state = git_repository_state(repo);
+	if (state != GIT_REPOSITORY_STATE_NONE) {
+		fprintf(stderr, "repository is in unexpected state %d\n", state);
+		goto cleanup;
+	}
+
+	if (args.pos >= args.argc) {
+		fprintf(stderr, "unhandled\n");
+		err = -1;
+		goto cleanup;
+	} else if (strcmp("--", args.argv[args.pos])) {
+		/**
+		 * Try to checkout the given path
+		 */
+
+		fprintf(stderr, "unhandled path-based checkout\n");
+		err = 1;
+		goto cleanup;
+	} else {
+		/**
+		 * Try to resolve a "refish" argument to a target libgit2 can use
+		 */
+		err = resolve_refish(&checkout_target, repo, args.argv[args.pos]);
+		if (err != 0) {
+			fprintf(stderr, "failed to resolve %s: %s\n", args.argv[args.pos], giterr_last()->message);
+			goto cleanup;
+		}
+		err = perform_checkout_ref(repo, checkout_target, &opts);
+	}
+
+cleanup:
+	git_annotated_commit_free(checkout_target);
+
+	git_repository_free(repo);
+	git_libgit2_shutdown();
+
+	return err;
+}
diff --git a/examples/common.c b/examples/common.c
index 1180720..8c10424 100644
--- a/examples/common.c
+++ b/examples/common.c
@@ -12,6 +12,8 @@
  * <http://creativecommons.org/publicdomain/zero/1.0/>.
  */
 
+#include <assert.h>
+
 #include "common.h"
 
 void check_lg2(int error, const char *message, const char *extra)
@@ -182,6 +184,25 @@ static int match_int_internal(
 	return 1;
 }
 
+int match_bool_arg(int *out, struct args_info *args, const char *opt)
+{
+	const char *found = args->argv[args->pos];
+
+	if (!strcmp(found, opt)) {
+		*out = 1;
+		return 1;
+	}
+
+	if (!strncmp(found, "--no-", strlen("--no-")) &&
+	    !strcmp(found + strlen("--no-"), opt + 2)) {
+		*out = 0;
+		return 1;
+	}
+
+	*out = -1;
+	return 0;
+}
+
 int is_integer(int *out, const char *str, int allow_negative)
 {
 	return match_int_internal(out, str, allow_negative, NULL);
@@ -245,3 +266,26 @@ void *xrealloc(void *oldp, size_t newsz)
 	return p;
 }
 
+int resolve_refish(git_annotated_commit **commit, git_repository *repo, const char *refish)
+{
+	git_reference *ref;
+	git_object *obj;
+	int err = 0;
+
+	assert(commit != NULL);
+
+	err = git_reference_dwim(&ref, repo, refish);
+	if (err == GIT_OK) {
+		git_annotated_commit_from_ref(commit, repo, ref);
+		git_reference_free(ref);
+		return 0;
+	}
+
+	err = git_revparse_single(&obj, repo, refish);
+	if (err == GIT_OK) {
+		err = git_annotated_commit_lookup(commit, repo, git_object_id(obj));
+		git_object_free(obj);
+	}
+
+	return err;
+}
diff --git a/examples/common.h b/examples/common.h
index af42324..1c7b203 100644
--- a/examples/common.h
+++ b/examples/common.h
@@ -91,6 +91,15 @@ extern int match_int_arg(
 	int *out, struct args_info *args, const char *opt, int allow_negative);
 
 /**
+ * Check current `args` entry against a "bool" `opt` (ie. --[no-]progress).
+ * If `opt` matches positively, out will be set to 1, or if `opt` matches
+ * negatively, out will be set to 0, and in both cases 1 will be returned.
+ * If neither the positive or the negative form of opt matched, out will be -1,
+ * and 0 will be returned.
+ */
+extern int match_bool_arg(int *out, struct args_info *args, const char *opt);
+
+/**
  * Basic output function for plain text diff output
  * Pass `FILE*` such as `stdout` or `stderr` as payload (or NULL == `stdout`)
  */
@@ -108,3 +117,8 @@ extern void treeish_to_tree(
  * A realloc that exits on failure
  */
 extern void *xrealloc(void *oldp, size_t newsz);
+
+/**
+ * Convert a refish to an annotated commit.
+ */
+extern int resolve_refish(git_annotated_commit **commit, git_repository *repo, const char *refish);
diff --git a/examples/merge.c b/examples/merge.c
index 59982cb..c819ad2 100644
--- a/examples/merge.c
+++ b/examples/merge.c
@@ -87,29 +87,6 @@ static void parse_options(const char **repo_path, merge_options *opts, int argc,
 	}
 }
 
-static int resolve_refish(git_annotated_commit **commit, git_repository *repo, const char *refish)
-{
-	git_reference *ref;
-	int err = 0;
-	git_oid oid;
-
-	assert(commit != NULL);
-
-	err = git_reference_dwim(&ref, repo, refish);
-	if (err == GIT_OK) {
-		git_annotated_commit_from_ref(commit, repo, ref);
-		git_reference_free(ref);
-		return 0;
-	}
-
-	err = git_oid_fromstr(&oid, refish);
-	if (err == GIT_OK) {
-		err = git_annotated_commit_lookup(commit, repo, &oid);
-	}
-
-	return err;
-}
-
 static int resolve_heads(git_repository *repo, merge_options *opts)
 {
 	git_annotated_commit **annotated = calloc(opts->heads_count, sizeof(git_annotated_commit *));
diff --git a/include/git2/annotated_commit.h b/include/git2/annotated_commit.h
index 7fb896a..fa795bf 100644
--- a/include/git2/annotated_commit.h
+++ b/include/git2/annotated_commit.h
@@ -104,6 +104,15 @@ GIT_EXTERN(const git_oid *) git_annotated_commit_id(
 	const git_annotated_commit *commit);
 
 /**
+ * Get the refname that the given `git_annotated_commit` refers to.
+ *
+ * @param commit the given annotated commit
+ * @return ref name.
+ */
+GIT_EXTERN(const char *) git_annotated_commit_ref(
+	const git_annotated_commit *commit);
+
+/**
  * Frees a `git_annotated_commit`.
  *
  * @param commit annotated commit to free
diff --git a/src/annotated_commit.c b/src/annotated_commit.c
index 72ba80a..1aa67dd 100644
--- a/src/annotated_commit.c
+++ b/src/annotated_commit.c
@@ -196,6 +196,13 @@ const git_oid *git_annotated_commit_id(
 	return git_commit_id(annotated_commit->commit);
 }
 
+const char *git_annotated_commit_ref(
+	const git_annotated_commit *annotated_commit)
+{
+	assert(annotated_commit);
+	return annotated_commit->ref_name;
+}
+
 void git_annotated_commit_free(git_annotated_commit *annotated_commit)
 {
 	if (annotated_commit == NULL)