strbuf: avoid shadowing global comment_line_char name

peff · gitster · commit 2786d058b6b2 · 2024-03-12T13:28:10.000-07:00
Several comment-related strbuf functions take a comment_line_char
parameter. There's also a global comment_line_char variable, which is
closely related (most callers pass it in as this parameter). Let's avoid
shadowing the global name. This makes it more obvious that we're not
using the global value, and it will be especially helpful as we refactor
the global in future patches (in particular, any macro trickery wouldn't
work because the preprocessor doesn't respect scope).

We'll use "comment_prefix". That should be descriptive enough, and as a
bonus is more neutral with respect to the "char" type (since we'll
eventually swap it out for a string).

Signed-off-by: Jeff King &lt;peff@peff.net&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/strbuf.c b/strbuf.c
@@ -359,16 +359,16 @@ static void add_lines(struct strbuf *out,
 }
 
 void strbuf_add_commented_lines(struct strbuf *out, const char *buf,
-				size_t size, char comment_line_char)
+				size_t size, char comment_prefix)
 {
 	char prefix[2];
 
-	prefix[0] = comment_line_char;
+	prefix[0] = comment_prefix;
 	prefix[1] = '\0';
 	add_lines(out, prefix, buf, size, 1);
 }
 
-void strbuf_commented_addf(struct strbuf *sb, char comment_line_char,
+void strbuf_commented_addf(struct strbuf *sb, char comment_prefix,
 			   const char *fmt, ...)
 {
 	va_list params;
@@ -379,7 +379,7 @@ void strbuf_commented_addf(struct strbuf *sb, char comment_line_char,
 	strbuf_vaddf(&buf, fmt, params);
 	va_end(params);
 
-	strbuf_add_commented_lines(sb, buf.buf, buf.len, comment_line_char);
+	strbuf_add_commented_lines(sb, buf.buf, buf.len, comment_prefix);
 	if (incomplete_line)
 		sb->buf[--sb->len] = '\0';
 
@@ -1001,10 +1001,10 @@ static size_t cleanup(char *line, size_t len)
  *
  * If last line does not have a newline at the end, one is added.
  *
- * Pass a non-NUL comment_line_char to skip every line starting
+ * Pass a non-NUL comment_prefix to skip every line starting
  * with it.
  */
-void strbuf_stripspace(struct strbuf *sb, char comment_line_char)
+void strbuf_stripspace(struct strbuf *sb, char comment_prefix)
 {
 	size_t empties = 0;
 	size_t i, j, len, newlen;
@@ -1017,8 +1017,8 @@ void strbuf_stripspace(struct strbuf *sb, char comment_line_char)
 		eol = memchr(sb->buf + i, '\n', sb->len - i);
 		len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
 
-		if (comment_line_char && len &&
-		    sb->buf[i] == comment_line_char) {
+		if (comment_prefix && len &&
+		    sb->buf[i] == comment_prefix) {
 			newlen = 0;
 			continue;
 		}
diff --git a/strbuf.h b/strbuf.h
@@ -288,7 +288,7 @@ void strbuf_splice(struct strbuf *sb, size_t pos, size_t len,
  */
 void strbuf_add_commented_lines(struct strbuf *out,
 				const char *buf, size_t size,
-				char comment_line_char);
+				char comment_prefix);
 
 
 /**
@@ -379,7 +379,7 @@ void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
  * blank to the buffer.
  */
 __attribute__((format (printf, 3, 4)))
-void strbuf_commented_addf(struct strbuf *sb, char comment_line_char, const char *fmt, ...);
+void strbuf_commented_addf(struct strbuf *sb, char comment_prefix, const char *fmt, ...);
 
 __attribute__((format (printf,2,0)))
 void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
@@ -513,11 +513,11 @@ int strbuf_getcwd(struct strbuf *sb);
 int strbuf_normalize_path(struct strbuf *sb);
 
 /**
- * Strip whitespace from a buffer. If comment_line_char is non-NUL,
+ * Strip whitespace from a buffer. If comment_prefix is non-NUL,
  * then lines beginning with that character are considered comments,
  * thus removed.
  */
-void strbuf_stripspace(struct strbuf *buf, char comment_line_char);
+void strbuf_stripspace(struct strbuf *buf, char comment_prefix);
 
 static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
 {

Original file line number	Diff line number	Diff line change
`@@ -359,16 +359,16 @@ static void add_lines(struct strbuf *out,`
`359`	`359`	`}`
`360`	`360`
`361`	`361`	`void strbuf_add_commented_lines(struct strbuf out, const char buf,`
`362`		`- size_t size, char comment_line_char)`
	`362`	`+ size_t size, char comment_prefix)`
`363`	`363`	`{`
`364`	`364`	`char prefix[2];`
`365`	`365`
`366`		`- prefix[0] = comment_line_char;`
	`366`	`+ prefix[0] = comment_prefix;`
`367`	`367`	`prefix[1] = '\0';`
`368`	`368`	`add_lines(out, prefix, buf, size, 1);`
`369`	`369`	`}`
`370`	`370`
`371`		`-void strbuf_commented_addf(struct strbuf *sb, char comment_line_char,`
	`371`	`+void strbuf_commented_addf(struct strbuf *sb, char comment_prefix,`
`372`	`372`	`const char *fmt, ...)`
`373`	`373`	`{`
`374`	`374`	`va_list params;`
`@@ -379,7 +379,7 @@ void strbuf_commented_addf(struct strbuf *sb, char comment_line_char,`
`379`	`379`	`strbuf_vaddf(&buf, fmt, params);`
`380`	`380`	`va_end(params);`
`381`	`381`
`382`		`- strbuf_add_commented_lines(sb, buf.buf, buf.len, comment_line_char);`
	`382`	`+ strbuf_add_commented_lines(sb, buf.buf, buf.len, comment_prefix);`
`383`	`383`	`if (incomplete_line)`
`384`	`384`	`sb->buf[--sb->len] = '\0';`
`385`	`385`
`@@ -1001,10 +1001,10 @@ static size_t cleanup(char *line, size_t len)`
`1001`	`1001`	`*`
`1002`	`1002`	`* If last line does not have a newline at the end, one is added.`
`1003`	`1003`	`*`
`1004`		`- * Pass a non-NUL comment_line_char to skip every line starting`
	`1004`	`+ * Pass a non-NUL comment_prefix to skip every line starting`
`1005`	`1005`	`* with it.`
`1006`	`1006`	`*/`
`1007`		`-void strbuf_stripspace(struct strbuf *sb, char comment_line_char)`
	`1007`	`+void strbuf_stripspace(struct strbuf *sb, char comment_prefix)`
`1008`	`1008`	`{`
`1009`	`1009`	`size_t empties = 0;`
`1010`	`1010`	`size_t i, j, len, newlen;`
`@@ -1017,8 +1017,8 @@ void strbuf_stripspace(struct strbuf *sb, char comment_line_char)`
`1017`	`1017`	`eol = memchr(sb->buf + i, '\n', sb->len - i);`
`1018`	`1018`	`len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;`
`1019`	`1019`
`1020`		`- if (comment_line_char && len &&`
`1021`		`- sb->buf[i] == comment_line_char) {`
	`1020`	`+ if (comment_prefix && len &&`
	`1021`	`+ sb->buf[i] == comment_prefix) {`
`1022`	`1022`	`newlen = 0;`
`1023`	`1023`	`continue;`
`1024`	`1024`	`}`