environment: store comment_line_char as a string

peff · gitster · commit 72a7d5d97fe0 · 2024-03-12T13:28:10.000-07:00
We'd like to eventually support multi-byte comment prefixes, but the
comment_line_char variable is referenced in many spots, making the
transition difficult.

Let's start by storing the character in a NUL-terminated string. That
will let us switch code over incrementally to the string format, and we
can easily support the existing code with a macro wrapper (since we'll
continue to allow only a single-byte prefix, this will behave
identically).

Once all references to the "char" variable have been converted, we can
drop it and enable longer strings.

We'll still have to touch all of the spots that create or set the
variable in this patch, but there are only a few (reading the config,
and the "auto" character selector).

Signed-off-by: Jeff King &lt;peff@peff.net&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/builtin/commit.c b/builtin/commit.c
@@ -685,7 +685,7 @@ static void adjust_comment_line_char(const struct strbuf *sb)
 	const char *p;
 
 	if (!memchr(sb->buf, candidates[0], sb->len)) {
-		comment_line_char = candidates[0];
+		comment_line_str = xstrfmt("%c", candidates[0]);
 		return;
 	}
 
@@ -706,7 +706,7 @@ static void adjust_comment_line_char(const struct strbuf *sb)
 	if (!*p)
 		die(_("unable to select a comment character that is not used\n"
 		      "in the current commit message"));
-	comment_line_char = *p;
+	comment_line_str = xstrfmt("%c", *p);
 }
 
 static void prepare_amend_commit(struct commit *commit, struct strbuf *sb,
diff --git a/config.c b/config.c
@@ -1568,7 +1568,7 @@ static int git_default_core_config(const char *var, const char *value,
 		else if (value[0] && !value[1]) {
 			if (value[0] == '\n')
 				return error(_("core.commentChar cannot be newline"));
-			comment_line_char = value[0];
+			comment_line_str = xstrfmt("%c", value[0]);
 			auto_comment_line_char = 0;
 		} else
 			return error(_("core.commentChar should only be one ASCII character"));
diff --git a/environment.c b/environment.c
@@ -110,7 +110,7 @@ int protect_ntfs = PROTECT_NTFS_DEFAULT;
  * The character that begins a commented line in user-editable file
  * that is subject to stripspace.
  */
-char comment_line_char = '#';
+const char *comment_line_str = "#";
 int auto_comment_line_char;
 
 /* Parallel index stat data preload? */
diff --git a/environment.h b/environment.h
@@ -8,7 +8,8 @@ struct strvec;
  * The character that begins a commented line in user-editable file
  * that is subject to stripspace.
  */
-extern char comment_line_char;
+#define comment_line_char (comment_line_str[0])
+extern const char *comment_line_str;
 extern int auto_comment_line_char;
 
 /*

Original file line number	Diff line number	Diff line change
`@@ -685,7 +685,7 @@ static void adjust_comment_line_char(const struct strbuf *sb)`
`685`	`685`	`const char *p;`
`686`	`686`
`687`	`687`	`if (!memchr(sb->buf, candidates[0], sb->len)) {`
`688`		`- comment_line_char = candidates[0];`
	`688`	`+ comment_line_str = xstrfmt("%c", candidates[0]);`
`689`	`689`	`return;`
`690`	`690`	`}`
`691`	`691`
`@@ -706,7 +706,7 @@ static void adjust_comment_line_char(const struct strbuf *sb)`
`706`	`706`	`if (!*p)`
`707`	`707`	`die(_("unable to select a comment character that is not used\n"`
`708`	`708`	`"in the current commit message"));`
`709`		`- comment_line_char = *p;`
	`709`	`+ comment_line_str = xstrfmt("%c", *p);`
`710`	`710`	`}`
`711`	`711`
`712`	`712`	`static void prepare_amend_commit(struct commit commit, struct strbuf sb,`