Merge pull request #1037 from libgit2/index-open-cleanup Some more changes to the Index API
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
diff --git a/include/git2/index.h b/include/git2/index.h
index 1d91663..bca9791 100644
--- a/include/git2/index.h
+++ b/include/git2/index.h
@@ -126,6 +126,19 @@ enum {
GIT_EXTERN(int) git_index_open(git_index **index, const char *index_path);
/**
+ * Create an in-memory index object.
+ *
+ * This index object cannot be read/written to the filesystem,
+ * but may be used to perform in-memory index operations.
+ *
+ * The index must be freed once it's no longer in use.
+ *
+ * @param index the pointer for the new index
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_index_new(git_index **index);
+
+/**
* Free an existing index object.
*
* @param index an existing index object
@@ -190,6 +203,38 @@ GIT_EXTERN(int) git_index_write(git_index *index);
*/
GIT_EXTERN(int) git_index_read_tree(git_index *index, git_tree *tree);
+/**
+ * Write the index as a tree
+ *
+ * This method will scan the index and write a representation
+ * of its current state back to disk; it recursively creates
+ * tree objects for each of the subtrees stored in the index,
+ * but only returns the OID of the root tree. This is the OID
+ * that can be used e.g. to create a commit.
+ *
+ * The index instance cannot be bare, and needs to be associated
+ * to an existing repository.
+ *
+ * @param oid Pointer where to store the OID of the written tree
+ * @param index Index to write
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_index_write_tree(git_oid *oid, git_index *index);
+
+/**
+ * Write the index as a tree to the given repository
+ *
+ * This method will do the same as `git_index_write_tree`, but
+ * letting the user choose the repository where the tree will
+ * be written.
+ *
+ * @param oid Pointer where to store OID of the the written tree
+ * @param index Index to write
+ * @param repo Repository where to write the tree
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_index_write_tree_to(git_oid *oid, git_index *index, git_repository *repo);
+
/**@}*/
/** @name Raw Index Entry Functions
diff --git a/include/git2/tree.h b/include/git2/tree.h
index 2ee1f4a..527f818 100644
--- a/include/git2/tree.h
+++ b/include/git2/tree.h
@@ -185,24 +185,6 @@ GIT_EXTERN(int) git_tree_entry_to_object(
const git_tree_entry *entry);
/**
- * Write a tree to the ODB from the index file
- *
- * This method will scan the index and write a representation
- * of its current state back to disk; it recursively creates
- * tree objects for each of the subtrees stored in the index,
- * but only returns the OID of the root tree. This is the OID
- * that can be used e.g. to create a commit.
- *
- * The index instance cannot be bare, and needs to be associated
- * to an existing repository.
- *
- * @param oid Pointer where to store the written tree
- * @param index Index to write
- * @return 0 or an error code
- */
-GIT_EXTERN(int) git_tree_create_fromindex(git_oid *oid, git_index *index);
-
-/**
* Create a new tree builder.
*
* The tree builder can be used to create or modify
diff --git a/src/index.c b/src/index.c
index 35cf5dd..cb83015 100644
--- a/src/index.c
+++ b/src/index.c
@@ -264,8 +264,14 @@ int git_index_open(git_index **index_out, const char *index_path)
index = git__calloc(1, sizeof(git_index));
GITERR_CHECK_ALLOC(index);
- index->index_file_path = git__strdup(index_path);
- GITERR_CHECK_ALLOC(index->index_file_path);
+ if (index_path != NULL) {
+ index->index_file_path = git__strdup(index_path);
+ GITERR_CHECK_ALLOC(index->index_file_path);
+
+ /* Check if index file is stored on disk already */
+ if (git_path_exists(index->index_file_path) == true)
+ index->on_disk = 1;
+ }
if (git_vector_init(&index->entries, 32, index_cmp) < 0)
return -1;
@@ -275,13 +281,15 @@ int git_index_open(git_index **index_out, const char *index_path)
index->entries_search_path = index_srch_path;
index->reuc_search = reuc_srch;
- /* Check if index file is stored on disk already */
- if (git_path_exists(index->index_file_path) == true)
- index->on_disk = 1;
-
*index_out = index;
GIT_REFCOUNT_INC(index);
- return git_index_read(index);
+
+ return (index_path != NULL) ? git_index_read(index) : 0;
+}
+
+int git_index_new(git_index **out)
+{
+ return git_index_open(out, NULL);
}
static void index_free(git_index *index)
@@ -334,7 +342,7 @@ void git_index_clear(git_index *index)
git_vector_clear(&index->entries);
git_vector_clear(&index->reuc);
- index->last_modified = 0;
+ git_futils_filestamp_set(&index->stamp, NULL);
git_tree_cache_free(index->tree);
index->tree = NULL;
@@ -390,11 +398,15 @@ unsigned int git_index_caps(const git_index *index)
int git_index_read(git_index *index)
{
- int error, updated;
+ int error = 0, updated;
git_buf buffer = GIT_BUF_INIT;
- time_t mtime;
+ git_futils_filestamp stamp;
- assert(index->index_file_path);
+ if (!index->index_file_path) {
+ giterr_set(GITERR_INDEX,
+ "Failed to read index: The index is in-memory only");
+ return -1;
+ }
if (!index->on_disk || git_path_exists(index->index_file_path) == false) {
git_index_clear(index);
@@ -402,32 +414,35 @@ int git_index_read(git_index *index)
return 0;
}
- /* We don't want to update the mtime if we fail to parse the index */
- mtime = index->last_modified;
- error = git_futils_readbuffer_updated(
- &buffer, index->index_file_path, &mtime, NULL, &updated);
+ updated = git_futils_filestamp_check(&stamp, index->index_file_path);
+ if (updated <= 0)
+ return updated;
+
+ error = git_futils_readbuffer(&buffer, index->index_file_path);
if (error < 0)
return error;
- if (updated) {
- git_index_clear(index);
- error = parse_index(index, buffer.ptr, buffer.size);
-
- if (!error)
- index->last_modified = mtime;
+ git_index_clear(index);
+ error = parse_index(index, buffer.ptr, buffer.size);
- git_buf_free(&buffer);
- }
+ if (!error)
+ git_futils_filestamp_set(&index->stamp, &stamp);
+ git_buf_free(&buffer);
return error;
}
int git_index_write(git_index *index)
{
git_filebuf file = GIT_FILEBUF_INIT;
- struct stat indexst;
int error;
+ if (!index->index_file_path) {
+ giterr_set(GITERR_INDEX,
+ "Failed to write index: The index is in-memory only");
+ return -1;
+ }
+
git_vector_sort(&index->entries);
git_vector_sort(&index->reuc);
@@ -443,14 +458,37 @@ int git_index_write(git_index *index)
if ((error = git_filebuf_commit(&file, GIT_INDEX_FILE_MODE)) < 0)
return error;
- if (p_stat(index->index_file_path, &indexst) == 0) {
- index->last_modified = indexst.st_mtime;
- index->on_disk = 1;
- }
+ error = git_futils_filestamp_check(&index->stamp, index->index_file_path);
+ if (error < 0)
+ return error;
+ index->on_disk = 1;
return 0;
}
+int git_index_write_tree(git_oid *oid, git_index *index)
+{
+ git_repository *repo;
+
+ assert(oid && index);
+
+ repo = (git_repository *)GIT_REFCOUNT_OWNER(index);
+
+ if (repo == NULL) {
+ giterr_set(GITERR_INDEX, "Failed to write tree. "
+ "The index file is not backed up by an existing repository");
+ return -1;
+ }
+
+ return git_tree__write_index(oid, index, repo);
+}
+
+int git_index_write_tree_to(git_oid *oid, git_index *index, git_repository *repo)
+{
+ assert(oid && index && repo);
+ return git_tree__write_index(oid, index, repo);
+}
+
unsigned int git_index_entrycount(git_index *index)
{
assert(index);
diff --git a/src/index.h b/src/index.h
index 0fd59dd..86158eb 100644
--- a/src/index.h
+++ b/src/index.h
@@ -22,7 +22,7 @@ struct git_index {
char *index_file_path;
- time_t last_modified;
+ git_futils_filestamp stamp;
git_vector entries;
unsigned int on_disk:1;
diff --git a/src/stash.c b/src/stash.c
index 9c9c5dc..1d6940e 100644
--- a/src/stash.c
+++ b/src/stash.c
@@ -115,7 +115,7 @@ static int build_tree_from_index(git_tree **out, git_index *index)
{
git_oid i_tree_oid;
- if (git_tree_create_fromindex(&i_tree_oid, index) < 0)
+ if (git_index_write_tree(&i_tree_oid, index) < 0)
return -1;
return git_tree_lookup(out, git_index_owner(index), &i_tree_oid);
diff --git a/src/tree.c b/src/tree.c
index 9ecefbb..46b4a6d 100644
--- a/src/tree.c
+++ b/src/tree.c
@@ -491,16 +491,11 @@ on_error:
return -1;
}
-int git_tree_create_fromindex(git_oid *oid, git_index *index)
+int git_tree__write_index(git_oid *oid, git_index *index, git_repository *repo)
{
int ret;
- git_repository *repo;
- repo = (git_repository *)GIT_REFCOUNT_OWNER(index);
-
- if (repo == NULL)
- return tree_error("Failed to create tree. "
- "The index file is not backed up by an existing repository");
+ assert(oid && index && repo);
if (index->tree != NULL && index->tree->entries >= 0) {
git_oid_cpy(oid, &index->tree->oid);
diff --git a/src/tree.h b/src/tree.h
index 24b517c..b67c552 100644
--- a/src/tree.h
+++ b/src/tree.h
@@ -47,6 +47,12 @@ int git_tree__parse(git_tree *tree, git_odb_object *obj);
*/
int git_tree__prefix_position(git_tree *tree, const char *prefix);
+
+/**
+ * Write a tree to the given repository
+ */
+int git_tree__write_index(git_oid *oid, git_index *index, git_repository *repo);
+
/**
* Obsolete mode kept for compatibility reasons
*/
diff --git a/tests-clar/index/read_tree.c b/tests-clar/index/read_tree.c
index f63a54b..3ae883d 100644
--- a/tests-clar/index/read_tree.c
+++ b/tests-clar/index/read_tree.c
@@ -29,14 +29,14 @@ void test_index_read_tree__read_write_involution(void)
cl_git_pass(git_index_add_from_workdir(index, "abc/d"));
/* write-tree */
- cl_git_pass(git_tree_create_fromindex(&expected, index));
+ cl_git_pass(git_index_write_tree(&expected, index));
/* read-tree */
git_tree_lookup(&tree, repo, &expected);
cl_git_pass(git_index_read_tree(index, tree));
git_tree_free(tree);
- cl_git_pass(git_tree_create_fromindex(&tree_oid, index));
+ cl_git_pass(git_index_write_tree(&tree_oid, index));
cl_assert(git_oid_cmp(&expected, &tree_oid) == 0);
git_index_free(index);
diff --git a/tests-clar/object/commit/commitstagedfile.c b/tests-clar/object/commit/commitstagedfile.c
index ac38acf..eb78ced 100644
--- a/tests-clar/object/commit/commitstagedfile.c
+++ b/tests-clar/object/commit/commitstagedfile.c
@@ -99,7 +99,7 @@ void test_object_commit_commitstagedfile__generate_predictable_object_ids(void)
/*
* Build the tree from the index
*/
- cl_git_pass(git_tree_create_fromindex(&tree_oid, index));
+ cl_git_pass(git_index_write_tree(&tree_oid, index));
cl_assert(git_oid_cmp(&expected_tree_oid, &tree_oid) == 0);
diff --git a/tests-clar/stash/stash_helpers.c b/tests-clar/stash/stash_helpers.c
index 0e93ecf..000a0f1 100644
--- a/tests-clar/stash/stash_helpers.c
+++ b/tests-clar/stash/stash_helpers.c
@@ -13,7 +13,7 @@ void commit_staged_files(
repo = git_index_owner(index);
- cl_git_pass(git_tree_create_fromindex(&tree_oid, index));
+ cl_git_pass(git_index_write_tree(&tree_oid, index));
cl_git_pass(git_tree_lookup(&tree, repo, &tree_oid));
cl_git_pass(git_commit_create_v(