4 int quote_path_fully = 1;
6 /* Help to copy the thing properly quoted for the shell safety.
7 * any single quote is replaced with '\'', any exclamation point
8 * is replaced with '\!', and the whole thing is enclosed in a
11 * original sq_quote result
12 * name ==> name ==> 'name'
13 * a b ==> a b ==> 'a b'
14 * a'b ==> a'\''b ==> 'a'\''b'
15 * a!b ==> a'\!'b ==> 'a'\!'b'
17 static inline int need_bs_quote(char c)
19 return (c == '\'' || c == '!');
22 void sq_quote_buf(struct strbuf *dst, const char *src)
27 to_free = strbuf_detach(dst, NULL);
29 strbuf_addch(dst, '\'');
31 size_t len = strcspn(src, "'!");
32 strbuf_add(dst, src, len);
34 while (need_bs_quote(*src)) {
35 strbuf_addstr(dst, "'\\");
36 strbuf_addch(dst, *src++);
37 strbuf_addch(dst, '\'');
40 strbuf_addch(dst, '\'');
44 void sq_quote_print(FILE *stream, const char *src)
49 while ((c = *src++)) {
50 if (need_bs_quote(c)) {
61 void sq_quote_argv(struct strbuf *dst, const char** argv, size_t maxlen)
65 /* Copy into destination buffer. */
66 strbuf_grow(dst, 255);
67 for (i = 0; argv[i]; ++i) {
68 strbuf_addch(dst, ' ');
69 sq_quote_buf(dst, argv[i]);
70 if (maxlen && dst->len > maxlen)
71 die("Too many or long arguments");
75 char *sq_dequote_step(char *arg, char **next)
91 /* We stepped out of sq */
100 if (need_bs_quote(c) && *++src == '\'') {
106 if (!next || !isspace(*src))
110 } while (isspace(c));
118 char *sq_dequote(char *arg)
120 return sq_dequote_step(arg, NULL);
123 int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc)
130 char *dequoted = sq_dequote_step(next, &next);
133 ALLOC_GROW(*argv, *nr + 1, *alloc);
134 (*argv)[(*nr)++] = dequoted;
140 /* 1 means: quote as octal
141 * 0 means: quote as octal if (quote_path_fully)
142 * -1 means: never quote
145 #define X8(x) x, x, x, x, x, x, x, x
146 #define X16(x) X8(x), X8(x)
147 static signed char const sq_lookup[256] = {
148 /* 0 1 2 3 4 5 6 7 */
149 /* 0x00 */ 1, 1, 1, 1, 1, 1, 1, 'a',
150 /* 0x08 */ 'b', 't', 'n', 'v', 'f', 'r', 1, 1,
152 /* 0x20 */ -1, -1, '"', -1, -1, -1, -1, -1,
153 /* 0x28 */ X16(-1), X16(-1), X16(-1),
154 /* 0x58 */ -1, -1, -1, -1,'\\', -1, -1, -1,
155 /* 0x60 */ X16(-1), X8(-1),
156 /* 0x78 */ -1, -1, -1, -1, -1, -1, -1, 1,
157 /* 0x80 */ /* set to 0 */
160 static inline int sq_must_quote(char c)
162 return sq_lookup[(unsigned char)c] + quote_path_fully > 0;
166 * Returns the longest prefix not needing a quote up to maxlen if
168 * This stops at the first \0 because it's marked as a character
171 static ssize_t next_quote_pos(const char *s, ssize_t maxlen)
176 for (len = 0; !sq_must_quote(s[len]); len++);
178 for (len = 0; len < maxlen && !sq_must_quote(s[len]); len++);
184 * C-style name quoting.
186 * (1) if sb and fp are both NULL, inspect the input name and counts the
187 * number of bytes that are needed to hold c_style quoted version of name,
188 * counting the double quotes around it but not terminating NUL, and
190 * However, if name does not need c_style quoting, it returns 0.
192 * (2) if sb or fp are not NULL, it emits the c_style quoted version
193 * of name, enclosed with double quotes if asked and needed only.
194 * Return value is the same as in (1).
196 static size_t quote_c_style_counted(const char *name, ssize_t maxlen,
197 struct strbuf *sb, FILE *fp, int no_dq)
201 if (sb) strbuf_addch(sb, (c)); \
202 if (fp) fputc((c), fp); \
206 #define EMITBUF(s, l) \
209 if (sb) strbuf_add(sb, (s), (l)); \
210 if (fp) __ret = fwrite((s), (l), 1, fp); \
214 ssize_t len, count = 0;
215 const char *p = name;
220 len = next_quote_pos(p, maxlen);
221 if (len == maxlen || !p[len])
224 if (!no_dq && p == name)
230 ch = (unsigned char)*p++;
231 if (sq_lookup[ch] >= ' ') {
234 EMIT(((ch >> 6) & 03) + '0');
235 EMIT(((ch >> 3) & 07) + '0');
236 EMIT(((ch >> 0) & 07) + '0');
241 if (p == name) /* no ending quote needed */
249 size_t quote_c_style(const char *name, struct strbuf *sb, FILE *fp, int nodq)
251 return quote_c_style_counted(name, -1, sb, fp, nodq);
254 void quote_two_c_style(struct strbuf *sb, const char *prefix, const char *path, int nodq)
256 if (quote_c_style(prefix, NULL, NULL, 0) ||
257 quote_c_style(path, NULL, NULL, 0)) {
259 strbuf_addch(sb, '"');
260 quote_c_style(prefix, sb, NULL, 1);
261 quote_c_style(path, sb, NULL, 1);
263 strbuf_addch(sb, '"');
265 strbuf_addstr(sb, prefix);
266 strbuf_addstr(sb, path);
270 void write_name_quoted(const char *name, FILE *fp, int terminator)
273 quote_c_style(name, NULL, fp, 0);
277 fputc(terminator, fp);
280 void write_name_quotedpfx(const char *pfx, ssize_t pfxlen,
281 const char *name, FILE *fp, int terminator)
286 needquote = next_quote_pos(pfx, pfxlen) < pfxlen
287 || name[next_quote_pos(name, -1)];
291 quote_c_style_counted(pfx, pfxlen, NULL, fp, 1);
292 quote_c_style(name, NULL, fp, 1);
297 ret = fwrite(pfx, pfxlen, 1, fp);
300 fputc(terminator, fp);
303 /* quote path as relative to the given prefix */
304 char *quote_path_relative(const char *in, int len,
305 struct strbuf *out, const char *prefix)
312 /* "../" prefix itself does not need quoting, but "in" might. */
313 needquote = (next_quote_pos(in, len) < len);
314 strbuf_setlen(out, 0);
315 strbuf_grow(out, len);
318 strbuf_addch(out, '"');
321 while (off < len && prefix[off] && prefix[off] == in[off])
322 if (prefix[off] == '/') {
330 for (; *prefix; prefix++)
332 strbuf_addstr(out, "../");
335 quote_c_style_counted (in, len, out, NULL, 1);
338 strbuf_addch(out, '"');
340 strbuf_addstr(out, "./");
346 * C-style name unquoting.
348 * Quoted should point at the opening double quote.
349 * + Returns 0 if it was able to unquote the string properly, and appends the
350 * result in the strbuf `sb'.
351 * + Returns -1 in case of error, and doesn't touch the strbuf. Though note
352 * that this function will allocate memory in the strbuf, so calling
353 * strbuf_release is mandatory whichever result unquote_c_style returns.
355 * Updates endp pointer to point at one past the ending double quote if given.
357 int unquote_c_style(struct strbuf *sb, const char *quoted, const char **endp)
359 size_t oldlen = sb->len, len;
362 if (*quoted++ != '"')
366 len = strcspn(quoted, "\"\\");
367 strbuf_add(sb, quoted, len);
381 switch ((ch = *quoted++)) {
382 case 'a': ch = '\a'; break;
383 case 'b': ch = '\b'; break;
384 case 'f': ch = '\f'; break;
385 case 'n': ch = '\n'; break;
386 case 'r': ch = '\r'; break;
387 case 't': ch = '\t'; break;
388 case 'v': ch = '\v'; break;
391 break; /* verbatim */
393 /* octal values with first digit over 4 overflow */
394 case '0': case '1': case '2': case '3':
395 ac = ((ch - '0') << 6);
396 if ((ch = *quoted++) < '0' || '7' < ch)
398 ac |= ((ch - '0') << 3);
399 if ((ch = *quoted++) < '0' || '7' < ch)
407 strbuf_addch(sb, ch);
411 strbuf_setlen(sb, oldlen);
415 /* quoting as a string literal for other languages */
417 void perl_quote_print(FILE *stream, const char *src)
419 const char sq = '\'';
420 const char bq = '\\';
424 while ((c = *src++)) {
425 if (c == sq || c == bq)
432 void python_quote_print(FILE *stream, const char *src)
434 const char sq = '\'';
435 const char bq = '\\';
436 const char nl = '\n';
440 while ((c = *src++)) {
446 if (c == sq || c == bq)
453 void tcl_quote_print(FILE *stream, const char *src)
458 while ((c = *src++)) {
462 case '$': case '\\': case '"':
468 fputs("\\f", stream);
471 fputs("\\r", stream);
474 fputs("\\n", stream);
477 fputs("\\t", stream);
480 fputs("\\v", stream);