Merge pull request #576 from carlosmn/revwalk Friendlier revision walking
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
diff --git a/include/git2/revwalk.h b/include/git2/revwalk.h
index 1af0e42..e7ec2ab 100644
--- a/include/git2/revwalk.h
+++ b/include/git2/revwalk.h
@@ -101,6 +101,28 @@ GIT_EXTERN(void) git_revwalk_reset(git_revwalk *walker);
*/
GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *oid);
+/**
+ * Push matching references
+ *
+ * The OIDs pinted to by the references that match the given glob
+ * pattern will be pushed to the revision walker.
+ *
+ * A leading 'refs/' is implied it not present as well as a trailing
+ * '/ *' if the glob lacks '?', '*' or '['.
+ *
+ * @param walk the walker being used for the traversal
+ * @param glob the glob pattern references should match
+ * @return GIT_SUCCESS or an error code
+ */
+GIT_EXTERN(int) git_revwalk_push_glob(git_revwalk *walk, const char *glob);
+
+/**
+ * Push the repository's HEAD
+ *
+ * @param walk the walker being used for the traversal
+ * @return GIT_SUCCESS or an error code
+ */
+GIT_EXTERN(int) git_revwalk_push_head(git_revwalk *walk);
/**
* Mark a commit (and its ancestors) uninteresting for the output.
@@ -118,6 +140,30 @@ GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *oid);
GIT_EXTERN(int) git_revwalk_hide(git_revwalk *walk, const git_oid *oid);
/**
+ * Hide matching references.
+ *
+ * The OIDs pinted to by the references that match the given glob
+ * pattern and their ancestors will be hidden from the output on the
+ * revision walk.
+ *
+ * A leading 'refs/' is implied it not present as well as a trailing
+ * '/ *' if the glob lacks '?', '*' or '['.
+ *
+ * @param walk the walker being used for the traversal
+ * @param glob the glob pattern references should match
+ * @return GIT_SUCCESS or an error code
+ */
+GIT_EXTERN(int) git_revwalk_hide_glob(git_revwalk *walk, const char *glob);
+
+/**
+ * Hide the repository's HEAD
+ *
+ * @param walk the walker being used for the traversal
+ * @return GIT_SUCCESS or an error code
+ */
+GIT_EXTERN(int) git_revwalk_hide_head(git_revwalk *walk);
+
+/**
* Get the next commit from the revision walk.
*
* The initial call to this method is *not* blocking when
diff --git a/src/revwalk.c b/src/revwalk.c
index 49d4b72..cd971b5 100644
--- a/src/revwalk.c
+++ b/src/revwalk.c
@@ -13,6 +13,8 @@
#include "git2/revwalk.h"
+#include <regex.h>
+
typedef struct commit_object {
git_oid oid;
uint32_t time;
@@ -298,12 +300,130 @@ int git_revwalk_push(git_revwalk *walk, const git_oid *oid)
return push_commit(walk, oid, 0);
}
+
int git_revwalk_hide(git_revwalk *walk, const git_oid *oid)
{
assert(walk && oid);
return push_commit(walk, oid, 1);
}
+struct push_cb_data {
+ git_revwalk *walk;
+ const char *glob;
+ int hide;
+};
+
+static int push_glob_cb(const char *refname, void *data_)
+{
+ struct push_cb_data *data = (struct push_cb_data *)data_;
+
+ if (!git__fnmatch(data->glob, refname, 0)) {
+ git_reference *ref, *resolved;
+ int error;
+
+ error = git_reference_lookup(&ref, data->walk->repo, refname);
+ if (error < GIT_SUCCESS)
+ return error;
+ error = git_reference_resolve(&resolved, ref);
+ git_reference_free(ref);
+ if (error < GIT_SUCCESS)
+ return error;
+ error = push_commit(data->walk, git_reference_oid(resolved), data->hide);
+ git_reference_free(resolved);
+ return error;
+ }
+
+ return GIT_SUCCESS;
+}
+
+static int push_glob(git_revwalk *walk, const char *glob, int hide)
+{
+ git_buf buf = GIT_BUF_INIT;
+ struct push_cb_data data;
+ int error;
+ regex_t preg;
+
+ assert(walk && glob);
+
+ /* refs/ is implied if not given in the glob */
+ if (strncmp(glob, GIT_REFS_DIR, strlen(GIT_REFS_DIR))) {
+ git_buf_printf(&buf, GIT_REFS_DIR "%s", glob);
+ } else {
+ git_buf_puts(&buf, glob);
+ }
+
+ /* If no '?', '*' or '[' exist, we append '/ *' to the glob */
+ memset(&preg, 0x0, sizeof(regex_t));
+ if (regcomp(&preg, "[?*[]", REG_EXTENDED)) {
+ error = git__throw(GIT_EOSERR, "Regex failed to compile");
+ goto cleanup;
+ }
+
+ if (regexec(&preg, glob, 0, NULL, 0))
+ git_buf_puts(&buf, "/*");
+
+ if (git_buf_oom(&buf)) {
+ error = GIT_ENOMEM;
+ goto cleanup;
+ }
+
+ data.walk = walk;
+ data.glob = git_buf_cstr(&buf);
+ data.hide = hide;
+
+ error = git_reference_foreach(walk->repo, GIT_REF_LISTALL, push_glob_cb, &data);
+
+cleanup:
+ regfree(&preg);
+ git_buf_free(&buf);
+ return error;
+}
+
+int git_revwalk_push_glob(git_revwalk *walk, const char *glob)
+{
+ assert(walk && glob);
+ return push_glob(walk, glob, 0);
+}
+
+int git_revwalk_hide_glob(git_revwalk *walk, const char *glob)
+{
+ assert(walk && glob);
+ return push_glob(walk, glob, 1);
+}
+
+static int push_head(git_revwalk *walk, int hide)
+{
+ git_reference *ref, *resolved;
+ int error;
+
+ error = git_reference_lookup(&ref, walk->repo, "HEAD");
+ if (error < GIT_SUCCESS) {
+ return error;
+ }
+ error = git_reference_resolve(&resolved, ref);
+ if (error < GIT_SUCCESS) {
+ return error;
+ }
+ git_reference_free(ref);
+
+ error = push_commit(walk, git_reference_oid(resolved), hide);
+
+ git_reference_free(resolved);
+ return error;
+}
+
+int git_revwalk_push_head(git_revwalk *walk)
+{
+ assert(walk);
+ return push_head(walk, 0);
+}
+
+int git_revwalk_hide_head(git_revwalk *walk)
+{
+ assert(walk);
+ return push_head(walk, 1);
+}
+
static int revwalk_enqueue_timesort(git_revwalk *walk, commit_object *commit)
{
return git_pqueue_insert(&walk->iterator_time, commit);
diff --git a/tests-clar/revwalk/basic.c b/tests-clar/revwalk/basic.c
new file mode 100644
index 0000000..cc88ec6
--- /dev/null
+++ b/tests-clar/revwalk/basic.c
@@ -0,0 +1,166 @@
+#include "clar_libgit2.h"
+
+/*
+ $ git log --oneline --graph --decorate
+ * a4a7dce (HEAD, br2) Merge branch 'master' into br2
+ |\
+ | * 9fd738e (master) a fourth commit
+ | * 4a202b3 a third commit
+ * | c47800c branch commit one
+ |/
+ * 5b5b025 another commit
+ * 8496071 testing
+*/
+static const char *commit_head = "a4a7dce85cf63874e984719f4fdd239f5145052f";
+
+static const char *commit_ids[] = {
+ "a4a7dce85cf63874e984719f4fdd239f5145052f", /* 0 */
+ "9fd738e8f7967c078dceed8190330fc8648ee56a", /* 1 */
+ "4a202b346bb0fb0db7eff3cffeb3c70babbd2045", /* 2 */
+ "c47800c7266a2be04c571c04d5a6614691ea99bd", /* 3 */
+ "8496071c1b46c854b31185ea97743be6a8774479", /* 4 */
+ "5b5b025afb0b4c913b4c338a42934a3863bf3644", /* 5 */
+};
+
+/* Careful: there are two possible topological sorts */
+static const int commit_sorting_topo[][6] = {
+ {0, 1, 2, 3, 5, 4}, {0, 3, 1, 2, 5, 4}
+};
+
+static const int commit_sorting_time[][6] = {
+ {0, 3, 1, 2, 5, 4}
+};
+
+static const int commit_sorting_topo_reverse[][6] = {
+ {4, 5, 3, 2, 1, 0}, {4, 5, 2, 1, 3, 0}
+};
+
+static const int commit_sorting_time_reverse[][6] = {
+ {4, 5, 2, 1, 3, 0}
+};
+
+#define commit_count 6
+static const int result_bytes = 24;
+
+
+static int get_commit_index(git_oid *raw_oid)
+{
+ int i;
+ char oid[40];
+
+ git_oid_fmt(oid, raw_oid);
+
+ for (i = 0; i < commit_count; ++i)
+ if (memcmp(oid, commit_ids[i], 40) == 0)
+ return i;
+
+ return -1;
+}
+
+static int test_walk(git_revwalk *walk, const git_oid *root,
+ int flags, const int possible_results[][6], int results_count)
+{
+ git_oid oid;
+
+ int i;
+ int result_array[commit_count];
+
+ git_revwalk_sorting(walk, flags);
+ git_revwalk_push(walk, root);
+
+ for (i = 0; i < commit_count; ++i)
+ result_array[i] = -1;
+
+ i = 0;
+
+ while (git_revwalk_next(&oid, walk) == GIT_SUCCESS) {
+ result_array[i++] = get_commit_index(&oid);
+ /*{
+ char str[41];
+ git_oid_fmt(str, &oid);
+ str[40] = 0;
+ printf(" %d) %s\n", i, str);
+ }*/
+ }
+
+ for (i = 0; i < results_count; ++i)
+ if (memcmp(possible_results[i],
+ result_array, result_bytes) == 0)
+ return GIT_SUCCESS;
+
+ return GIT_ERROR;
+}
+
+static git_repository *_repo;
+static git_revwalk *_walk;
+
+void test_revwalk_basic__initialize(void)
+{
+ cl_git_pass(git_repository_open(&_repo, cl_fixture("testrepo.git")));
+ cl_git_pass(git_revwalk_new(&_walk, _repo));
+}
+
+void test_revwalk_basic__cleanup(void)
+{
+ git_revwalk_free(_walk);
+ git_repository_free(_repo);
+}
+
+void test_revwalk_basic__sorting_modes(void)
+{
+ git_oid id;
+
+ git_oid_fromstr(&id, commit_head);
+
+ cl_git_pass(test_walk(_walk, &id, GIT_SORT_TIME, commit_sorting_time, 1));
+ cl_git_pass(test_walk(_walk, &id, GIT_SORT_TOPOLOGICAL, commit_sorting_topo, 2));
+ cl_git_pass(test_walk(_walk, &id, GIT_SORT_TIME | GIT_SORT_REVERSE, commit_sorting_time_reverse, 1));
+ cl_git_pass(test_walk(_walk, &id, GIT_SORT_TOPOLOGICAL | GIT_SORT_REVERSE, commit_sorting_topo_reverse, 2));
+}
+
+void test_revwalk_basic__glob_heads(void)
+{
+ int i = 0;
+ git_oid oid;
+
+ cl_git_pass(git_revwalk_push_glob(_walk, "heads"));
+
+ while (git_revwalk_next(&oid, _walk) == GIT_SUCCESS) {
+ i++;
+ }
+
+ /* git log --branches --oneline | wc -l => 13 */
+ cl_assert(i == 13);
+}
+
+void test_revwalk_basic__push_head(void)
+{
+ int i = 0;
+ git_oid oid;
+
+ cl_git_pass(git_revwalk_push_head(_walk));
+
+ while (git_revwalk_next(&oid, _walk) == GIT_SUCCESS) {
+ i++;
+ }
+
+ /* git log HEAD --oneline | wc -l => 7 */
+ cl_assert(i == 7);
+}
+
+void test_revwalk_basic__push_head_hide_glob(void)
+{
+ int i = 0;
+ git_oid oid;
+
+ cl_git_pass(git_revwalk_push_head(_walk));
+ /* This is a hack, as we know this will only match the packed-test branch */
+ cl_git_pass(git_revwalk_hide_glob(_walk, "heads/packed-test*"));
+
+ while (git_revwalk_next(&oid, _walk) == GIT_SUCCESS) {
+ i++;
+ }
+
+ /* git log HEAD --oneline --not refs/heads/packed-test | wc -l => 4 */
+ cl_assert(i == 4);
+}