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, 35 insertions, 35 deletions

diff --git a/tests/repo/init.c b/tests/repo/init.c
index 1aa326f7f..b41608cca 100644
--- a/tests/repo/init.c
+++ b/tests/repo/init.c
@@ -12,7 +12,7 @@ enum repo_mode {
 };
 
 static git_repository *g_repo = NULL;
-static git_buf g_global_path = GIT_BUF_INIT;
+static git_str g_global_path = GIT_STR_INIT;
 
 void test_repo_init__initialize(void)
 {
@@ -26,7 +26,7 @@ void test_repo_init__cleanup(void)
 {
 	git_libgit2_opts(GIT_OPT_SET_SEARCH_PATH, GIT_CONFIG_LEVEL_GLOBAL,
 		g_global_path.ptr);
-	git_buf_dispose(&g_global_path);
+	git_str_dispose(&g_global_path);
 
 	cl_fixture_cleanup("tmp_global_path");
 }
@@ -100,16 +100,16 @@ void test_repo_init__bare_repo_noslash(void)
 
 void test_repo_init__bare_repo_escaping_current_workdir(void)
 {
-	git_buf path_repository = GIT_BUF_INIT;
-	git_buf path_current_workdir = GIT_BUF_INIT;
+	git_str path_repository = GIT_STR_INIT;
+	git_str path_current_workdir = GIT_STR_INIT;
 
 	cl_git_pass(git_path_prettify_dir(&path_current_workdir, ".", NULL));
 
-	cl_git_pass(git_buf_joinpath(&path_repository, git_buf_cstr(&path_current_workdir), "a/b/c"));
-	cl_git_pass(git_futils_mkdir_r(git_buf_cstr(&path_repository), GIT_DIR_MODE));
+	cl_git_pass(git_str_joinpath(&path_repository, git_str_cstr(&path_current_workdir), "a/b/c"));
+	cl_git_pass(git_futils_mkdir_r(git_str_cstr(&path_repository), GIT_DIR_MODE));
 
 	/* Change the current working directory */
-	cl_git_pass(chdir(git_buf_cstr(&path_repository)));
+	cl_git_pass(chdir(git_str_cstr(&path_repository)));
 
 	/* Initialize a bare repo with a relative path escaping out of the current working directory */
 	cl_git_pass(git_repository_init(&g_repo, "../d/e.git", 1));
@@ -121,10 +121,10 @@ void test_repo_init__bare_repo_escaping_current_workdir(void)
 	/* Open a bare repo with a relative path escaping out of the current working directory */
 	cl_git_pass(git_repository_open(&g_repo, "../d/e.git"));
 
-	cl_git_pass(chdir(git_buf_cstr(&path_current_workdir)));
+	cl_git_pass(chdir(git_str_cstr(&path_current_workdir)));
 
-	git_buf_dispose(&path_current_workdir);
-	git_buf_dispose(&path_repository);
+	git_str_dispose(&path_current_workdir);
+	git_str_dispose(&path_repository);
 
 	cleanup_repository("a");
 }
@@ -168,26 +168,26 @@ void test_repo_init__reinit_too_recent_bare_repo(void)
 
 void test_repo_init__additional_templates(void)
 {
-	git_buf path = GIT_BUF_INIT;
+	git_str path = GIT_STR_INIT;
 
 	cl_set_cleanup(&cleanup_repository, "tester");
 
 	ensure_repository_init("tester", 0, "tester/.git/", "tester/");
 
 	cl_git_pass(
-		git_buf_joinpath(&path, git_repository_path(g_repo), "description"));
-	cl_assert(git_path_isfile(git_buf_cstr(&path)));
+		git_str_joinpath(&path, git_repository_path(g_repo), "description"));
+	cl_assert(git_path_isfile(git_str_cstr(&path)));
 
 	cl_git_pass(
-		git_buf_joinpath(&path, git_repository_path(g_repo), "info/exclude"));
-	cl_assert(git_path_isfile(git_buf_cstr(&path)));
+		git_str_joinpath(&path, git_repository_path(g_repo), "info/exclude"));
+	cl_assert(git_path_isfile(git_str_cstr(&path)));
 
 	cl_git_pass(
-		git_buf_joinpath(&path, git_repository_path(g_repo), "hooks"));
-	cl_assert(git_path_isdir(git_buf_cstr(&path)));
+		git_str_joinpath(&path, git_repository_path(g_repo), "hooks"));
+	cl_assert(git_path_isdir(git_str_cstr(&path)));
 	/* won't confirm specific contents of hooks dir since it may vary */
 
-	git_buf_dispose(&path);
+	git_str_dispose(&path);
 }
 
 static void assert_config_entry_on_init_bytype(
@@ -447,7 +447,7 @@ void test_repo_init__extended_1(void)
 void test_repo_init__relative_gitdir(void)
 {
 	git_repository_init_options opts = GIT_REPOSITORY_INIT_OPTIONS_INIT;
-	git_buf dot_git_content = GIT_BUF_INIT;
+	git_str dot_git_content = GIT_STR_INIT;
 
 	opts.workdir_path = "../c_wd";
 	opts.flags =
@@ -472,18 +472,18 @@ void test_repo_init__relative_gitdir(void)
 	cl_git_pass(git_futils_readbuffer(&dot_git_content, "root/b/c_wd/.git"));
 	cl_assert_equal_s("gitdir: ../my_repository/", dot_git_content.ptr);
 
-	git_buf_dispose(&dot_git_content);
+	git_str_dispose(&dot_git_content);
 	cleanup_repository("root");
 }
 
 void test_repo_init__relative_gitdir_2(void)
 {
 	git_repository_init_options opts = GIT_REPOSITORY_INIT_OPTIONS_INIT;
-	git_buf dot_git_content = GIT_BUF_INIT;
-	git_buf full_path = GIT_BUF_INIT;
+	git_str dot_git_content = GIT_STR_INIT;
+	git_str full_path = GIT_STR_INIT;
 
 	cl_git_pass(git_path_prettify(&full_path, ".", NULL));
-	cl_git_pass(git_buf_joinpath(&full_path, full_path.ptr, "root/b/c_wd"));
+	cl_git_pass(git_str_joinpath(&full_path, full_path.ptr, "root/b/c_wd"));
 
 	opts.workdir_path = full_path.ptr;
 	opts.flags =
@@ -493,7 +493,7 @@ void test_repo_init__relative_gitdir_2(void)
 
 	/* make the directory first, then it should succeed */
 	cl_git_pass(git_repository_init_ext(&g_repo, "root/b/my_repository", &opts));
-	git_buf_dispose(&full_path);
+	git_str_dispose(&full_path);
 
 	cl_assert(!git__suffixcmp(git_repository_workdir(g_repo), "root/b/c_wd/"));
 	cl_assert(!git__suffixcmp(git_repository_path(g_repo), "root/b/my_repository/"));
@@ -509,7 +509,7 @@ void test_repo_init__relative_gitdir_2(void)
 	cl_git_pass(git_futils_readbuffer(&dot_git_content, "root/b/c_wd/.git"));
 	cl_assert_equal_s("gitdir: ../my_repository/", dot_git_content.ptr);
 
-	git_buf_dispose(&dot_git_content);
+	git_str_dispose(&dot_git_content);
 	cleanup_repository("root");
 }
 
@@ -598,7 +598,7 @@ void test_repo_init__at_filesystem_root(void)
 {
 	git_repository *repo;
 	const char *sandbox = clar_sandbox_path();
-	git_buf root = GIT_BUF_INIT;
+	git_str root = GIT_STR_INIT;
 	int root_len;
 
 	if (!cl_is_env_set("GITTEST_INVASIVE_FS_STRUCTURE"))
@@ -607,8 +607,8 @@ void test_repo_init__at_filesystem_root(void)
 	root_len = git_path_root(sandbox);
 	cl_assert(root_len >= 0);
 
-	git_buf_put(&root, sandbox, root_len+1);
-	git_buf_joinpath(&root, root.ptr, "libgit2_test_dir");
+	git_str_put(&root, sandbox, root_len+1);
+	git_str_joinpath(&root, root.ptr, "libgit2_test_dir");
 
 	cl_assert(!git_path_exists(root.ptr));
 
@@ -616,7 +616,7 @@ void test_repo_init__at_filesystem_root(void)
 	cl_assert(git_path_isdir(root.ptr));
 	cl_git_pass(git_futils_rmdir_r(root.ptr, NULL, GIT_RMDIR_REMOVE_FILES));
 
-	git_buf_dispose(&root);
+	git_str_dispose(&root);
 	git_repository_free(repo);
 }
 
@@ -710,29 +710,29 @@ void test_repo_init__longpath(void)
 #ifdef GIT_WIN32
 	size_t padding = CONST_STRLEN("objects/pack/pack-.pack.lock") + GIT_OID_HEXSZ;
 	size_t max, i;
-	git_buf path = GIT_BUF_INIT;
+	git_str path = GIT_STR_INIT;
 	git_repository *one = NULL, *two = NULL;
 
 	/*
 	 * Files within repositories need to fit within MAX_PATH;
 	 * that means a repo path must be at most (MAX_PATH - 18).
 	 */
-	cl_git_pass(git_buf_puts(&path, clar_sandbox_path()));
-	cl_git_pass(git_buf_putc(&path, '/'));
+	cl_git_pass(git_str_puts(&path, clar_sandbox_path()));
+	cl_git_pass(git_str_putc(&path, '/'));
 
 	max = ((MAX_PATH) - path.size) - padding;
 
 	for (i = 0; i < max - 1; i++)
-		cl_git_pass(git_buf_putc(&path, 'a'));
+		cl_git_pass(git_str_putc(&path, 'a'));
 
 	cl_git_pass(git_repository_init(&one, path.ptr, 1));
 
 	/* Paths longer than this are rejected */
-	cl_git_pass(git_buf_putc(&path, 'z'));
+	cl_git_pass(git_str_putc(&path, 'z'));
 	cl_git_fail(git_repository_init(&two, path.ptr, 1));
 
 	git_repository_free(one);
 	git_repository_free(two);
-	git_buf_dispose(&path);
+	git_str_dispose(&path);
 #endif
 }