str: introduce `git_str` for internal, `git_buf` is externalethomson/gitstr

libgit2 has two distinct requirements that were previously solved by
`git_buf`.  We require:

1. A general purpose string class that provides a number of utility APIs
   for manipulating data (eg, concatenating, truncating, etc).
2. A structure that we can use to return strings to callers that they
   can take ownership of.

By using a single class (`git_buf`) for both of these purposes, we have
confused the API to the point that refactorings are difficult and
reasoning about correctness is also difficult.

Move the utility class `git_buf` to be called `git_str`: this represents
its general purpose, as an internal string buffer class.  The name also
is an homage to Junio Hamano ("gitstr").

The public API remains `git_buf`, and has a much smaller footprint.  It
is generally only used as an "out" param with strict requirements that
follow the documentation.  (Exceptions exist for some legacy APIs to
avoid breaking callers unnecessarily.)

Utility functions exist to convert a user-specified `git_buf` to a
`git_str` so that we can call internal functions, then converting it
back again.

4 files changed, 23 insertions, 24 deletions

diff --git a/tests/odb/alternates.c b/tests/odb/alternates.c
index f65a44bb5..e36010b75 100644
--- a/tests/odb/alternates.c
+++ b/tests/odb/alternates.c
@@ -2,7 +2,7 @@
 #include "odb.h"
 #include "filebuf.h"
 
-static git_buf destpath, filepath;
+static git_str destpath, filepath;
 static const char *paths[] = {
 	"A.git", "B.git", "C.git", "D.git", "E.git", "F.git", "G.git"
 };
@@ -13,8 +13,8 @@ void test_odb_alternates__cleanup(void)
 {
 	size_t i;
 
-	git_buf_dispose(&destpath);
-	git_buf_dispose(&filepath);
+	git_str_dispose(&destpath);
+	git_str_dispose(&filepath);
 
 	for (i = 0; i < ARRAY_SIZE(paths); i++)
 		cl_fixture_cleanup(paths[i]);
@@ -22,18 +22,18 @@ void test_odb_alternates__cleanup(void)
 
 static void init_linked_repo(const char *path, const char *alternate)
 {
-	git_buf_clear(&destpath);
-	git_buf_clear(&filepath);
+	git_str_clear(&destpath);
+	git_str_clear(&filepath);
 
 	cl_git_pass(git_repository_init(&repo, path, 1));
 	cl_git_pass(git_path_prettify(&destpath, alternate, NULL));
-	cl_git_pass(git_buf_joinpath(&destpath, destpath.ptr, "objects"));
-	cl_git_pass(git_buf_joinpath(&filepath, git_repository_path(repo), "objects/info"));
+	cl_git_pass(git_str_joinpath(&destpath, destpath.ptr, "objects"));
+	cl_git_pass(git_str_joinpath(&filepath, git_repository_path(repo), "objects/info"));
 	cl_git_pass(git_futils_mkdir(filepath.ptr, 0755, GIT_MKDIR_PATH));
-	cl_git_pass(git_buf_joinpath(&filepath, filepath.ptr , "alternates"));
+	cl_git_pass(git_str_joinpath(&filepath, filepath.ptr , "alternates"));
 
-	cl_git_pass(git_filebuf_open(&file, git_buf_cstr(&filepath), 0, 0666));
-	git_filebuf_printf(&file, "%s\n", git_buf_cstr(&destpath));
+	cl_git_pass(git_filebuf_open(&file, git_str_cstr(&filepath), 0, 0666));
+	git_filebuf_printf(&file, "%s\n", git_str_cstr(&destpath));
 	cl_git_pass(git_filebuf_commit(&file));
 
 	git_repository_free(repo);
diff --git a/tests/odb/foreach.c b/tests/odb/foreach.c
index 02112380b..c2a448363 100644
--- a/tests/odb/foreach.c
+++ b/tests/odb/foreach.c
@@ -2,7 +2,6 @@
 #include "odb.h"
 #include "git2/odb_backend.h"
 #include "pack.h"
-#include "buffer.h"
 
 static git_odb *_odb;
 static git_repository *_repo;
@@ -121,15 +120,15 @@ void test_odb_foreach__files_in_objects_dir(void)
 {
 	git_repository *repo;
 	git_odb *odb;
-	git_buf buf = GIT_BUF_INIT;
+	git_str buf = GIT_STR_INIT;
 	int nobj = 0;
 
 	cl_fixture_sandbox("testrepo.git");
 	cl_git_pass(git_repository_open(&repo, "testrepo.git"));
 
-	cl_git_pass(git_buf_joinpath(&buf, git_repository_path(repo), "objects/somefile"));
+	cl_git_pass(git_str_joinpath(&buf, git_repository_path(repo), "objects/somefile"));
 	cl_git_mkfile(buf.ptr, "");
-	git_buf_dispose(&buf);
+	git_str_dispose(&buf);
 
 	cl_git_pass(git_repository_odb(&odb, repo));
 	cl_git_pass(git_odb_foreach(odb, foreach_cb, &nobj));
diff --git a/tests/odb/freshen.c b/tests/odb/freshen.c
index 1ecd92a8d..2396e3774 100644
--- a/tests/odb/freshen.c
+++ b/tests/odb/freshen.c
@@ -19,7 +19,7 @@ void test_odb_freshen__cleanup(void)
 
 static void set_time_wayback(struct stat *out, const char *fn)
 {
-	git_buf fullpath = GIT_BUF_INIT;
+	git_str fullpath = GIT_STR_INIT;
 	struct p_timeval old[2];
 
 	old[0].tv_sec = 1234567890;
@@ -27,11 +27,11 @@ static void set_time_wayback(struct stat *out, const char *fn)
 	old[1].tv_sec = 1234567890;
 	old[1].tv_usec = 0;
 
-	git_buf_joinpath(&fullpath, "testrepo.git/objects", fn);
+	git_str_joinpath(&fullpath, "testrepo.git/objects", fn);
 
-	cl_must_pass(p_utimes(git_buf_cstr(&fullpath), old));
-	cl_must_pass(p_lstat(git_buf_cstr(&fullpath), out));
-	git_buf_dispose(&fullpath);
+	cl_must_pass(p_utimes(git_str_cstr(&fullpath), old));
+	cl_must_pass(p_lstat(git_str_cstr(&fullpath), out));
+	git_str_dispose(&fullpath);
 }
 
 #define LOOSE_STR     "my new file\n"
diff --git a/tests/odb/largefiles.c b/tests/odb/largefiles.c
index ff82291b3..acc786ee4 100644
--- a/tests/odb/largefiles.c
+++ b/tests/odb/largefiles.c
@@ -23,11 +23,11 @@ void test_odb_largefiles__cleanup(void)
 static void writefile(git_oid *oid)
 {
 	static git_odb_stream *stream;
-	git_buf buf = GIT_BUF_INIT;
+	git_str buf = GIT_STR_INIT;
 	size_t i;
 
 	for (i = 0; i < 3041; i++)
-		cl_git_pass(git_buf_puts(&buf, "Hello, world.\n"));
+		cl_git_pass(git_str_puts(&buf, "Hello, world.\n"));
 
 	cl_git_pass(git_odb_open_wstream(&stream, odb, LARGEFILE_SIZE, GIT_OBJECT_BLOB));
 	for (i = 0; i < 126103; i++)
@@ -36,13 +36,13 @@ static void writefile(git_oid *oid)
 	cl_git_pass(git_odb_stream_finalize_write(oid, stream));
 
 	git_odb_stream_free(stream);
-	git_buf_dispose(&buf);
+	git_str_dispose(&buf);
 }
 
 void test_odb_largefiles__write_from_memory(void)
 {
 	git_oid expected, oid;
-	git_buf buf = GIT_BUF_INIT;
+	git_str buf = GIT_STR_INIT;
 	size_t i;
 
 #ifndef GIT_ARCH_64
@@ -55,7 +55,7 @@ void test_odb_largefiles__write_from_memory(void)
 		cl_skip();
 
 	for (i = 0; i < (3041*126103); i++)
-		cl_git_pass(git_buf_puts(&buf, "Hello, world.\n"));
+		cl_git_pass(git_str_puts(&buf, "Hello, world.\n"));
 
 	git_oid_fromstr(&expected, "3fb56989cca483b21ba7cb0a6edb229d10e1c26c");
 	cl_git_pass(git_odb_write(&oid, odb, buf.ptr, buf.size, GIT_OBJECT_BLOB));