quote: add sq_append_quote_argv_pretty()

jeffhostetler · gitster · commit c2b890aca508 · 2019-08-09T10:48:02.000-07:00
sq_quote_argv_pretty() builds a "pretty" string from the given argv.
It inserts whitespace before each value, rather than just between
them, so the resulting string always has a leading space.  Lets give
callers an option to not have the leading space or have to ltrim()
it later.

Create sq_append_quote_argv_pretty() to convert an argv into a
pretty, quoted if necessary, string with space delimiters and
without a leading space.

Convert the existing sq_quote_argv_pretty() to use this new routine
while preserving the leading space behavior.

Signed-off-by: Jeff Hostetler &lt;jeffhost@microsoft.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/quote.c b/quote.c
@@ -84,12 +84,28 @@ void sq_quote_argv(struct strbuf *dst, const char **argv)
 	}
 }
 
+/*
+ * Legacy function to append each argv value, quoted as necessasry,
+ * with whitespace before each value.  This results in a leading
+ * space in the result.
+ */
 void sq_quote_argv_pretty(struct strbuf *dst, const char **argv)
+{
+	if (argv[0])
+		strbuf_addch(dst, ' ');
+	sq_append_quote_argv_pretty(dst, argv);
+}
+
+/*
+ * Append each argv value, quoted as necessary, with whitespace between them.
+ */
+void sq_append_quote_argv_pretty(struct strbuf *dst, const char **argv)
 {
 	int i;
 
 	for (i = 0; argv[i]; i++) {
-		strbuf_addch(dst, ' ');
+		if (i > 0)
+			strbuf_addch(dst, ' ');
 		sq_quote_buf_pretty(dst, argv[i]);
 	}
 }
diff --git a/quote.h b/quote.h
@@ -40,6 +40,7 @@ void sq_quotef(struct strbuf *, const char *fmt, ...);
  */
 void sq_quote_buf_pretty(struct strbuf *, const char *src);
 void sq_quote_argv_pretty(struct strbuf *, const char **argv);
+void sq_append_quote_argv_pretty(struct strbuf *dst, const char **argv);
 
 /* This unwraps what sq_quote() produces in place, but returns
  * NULL if the input does not look like what sq_quote would have

Original file line number	Diff line number	Diff line change
`@@ -84,12 +84,28 @@ void sq_quote_argv(struct strbuf dst, const char *argv)`
`84`	`84`	`}`
`85`	`85`	`}`
`86`	`86`
	`87`	`+/*`
	`88`	`+ * Legacy function to append each argv value, quoted as necessasry,`
	`89`	`+ * with whitespace before each value. This results in a leading`
	`90`	`+ * space in the result.`
	`91`	`+ */`
`87`	`92`	`void sq_quote_argv_pretty(struct strbuf dst, const char *argv)`
	`93`	`+{`
	`94`	`+ if (argv[0])`
	`95`	`+ strbuf_addch(dst, ' ');`
	`96`	`+ sq_append_quote_argv_pretty(dst, argv);`
	`97`	`+}`
	`98`	`+`
	`99`	`+/*`
	`100`	`+ * Append each argv value, quoted as necessary, with whitespace between them.`
	`101`	`+ */`
	`102`	`+void sq_append_quote_argv_pretty(struct strbuf dst, const char *argv)`
`88`	`103`	`{`
`89`	`104`	`int i;`
`90`	`105`
`91`	`106`	`for (i = 0; argv[i]; i++) {`
`92`		`- strbuf_addch(dst, ' ');`
	`107`	`+ if (i > 0)`
	`108`	`+ strbuf_addch(dst, ' ');`
`93`	`109`	`sq_quote_buf_pretty(dst, argv[i]);`
`94`	`110`	`}`
`95`	`111`	`}`