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.

1 files changed, 14 insertions, 14 deletions

diff --git a/tests/core/futils.c b/tests/core/futils.c
index 2c8294c87..d08043b6e 100644
--- a/tests/core/futils.c
+++ b/tests/core/futils.c
@@ -14,27 +14,27 @@ void test_core_futils__cleanup(void)
 
 void test_core_futils__writebuffer(void)
 {
-	git_buf out = GIT_BUF_INIT,
-		append = GIT_BUF_INIT;
+	git_str out = GIT_STR_INIT,
+		append = GIT_STR_INIT;
 
 	/* create a new file */
-	git_buf_puts(&out, "hello!\n");
-	git_buf_printf(&out, "this is a %s\n", "test");
+	git_str_puts(&out, "hello!\n");
+	git_str_printf(&out, "this is a %s\n", "test");
 
 	cl_git_pass(git_futils_writebuffer(&out, "futils/test-file", O_RDWR|O_CREAT, 0666));
 
 	cl_assert_equal_file(out.ptr, out.size, "futils/test-file");
 
 	/* append some more data */
-	git_buf_puts(&append, "And some more!\n");
-	git_buf_put(&out, append.ptr, append.size);
+	git_str_puts(&append, "And some more!\n");
+	git_str_put(&out, append.ptr, append.size);
 
 	cl_git_pass(git_futils_writebuffer(&append, "futils/test-file", O_RDWR|O_APPEND, 0666));
 
 	cl_assert_equal_file(out.ptr, out.size, "futils/test-file");
 
-	git_buf_dispose(&out);
-	git_buf_dispose(&append);
+	git_str_dispose(&out);
+	git_str_dispose(&append);
 }
 
 void test_core_futils__write_hidden_file(void)
@@ -42,17 +42,17 @@ void test_core_futils__write_hidden_file(void)
 #ifndef GIT_WIN32
 	cl_skip();
 #else
-	git_buf out = GIT_BUF_INIT, append = GIT_BUF_INIT;
+	git_str out = GIT_STR_INIT, append = GIT_STR_INIT;
 	bool hidden;
 
-	git_buf_puts(&out, "hidden file.\n");
+	git_str_puts(&out, "hidden file.\n");
 	git_futils_writebuffer(&out, "futils/test-file", O_RDWR | O_CREAT, 0666);
 
 	cl_git_pass(git_win32__set_hidden("futils/test-file", true));
 
 	/* append some more data */
-	git_buf_puts(&append, "And some more!\n");
-	git_buf_put(&out, append.ptr, append.size);
+	git_str_puts(&append, "And some more!\n");
+	git_str_put(&out, append.ptr, append.size);
 
 	cl_git_pass(git_futils_writebuffer(&append, "futils/test-file", O_RDWR | O_APPEND, 0666));
 
@@ -61,8 +61,8 @@ void test_core_futils__write_hidden_file(void)
 	cl_git_pass(git_win32__hidden(&hidden, "futils/test-file"));
 	cl_assert(hidden);
 
-	git_buf_dispose(&out);
-	git_buf_dispose(&append);
+	git_str_dispose(&out);
+	git_str_dispose(&append);
 #endif
 }