.gitignore: "git-verify-commit" is a generated file
[git.git] / quote.c
blob45e3db12d514dd7393539ca0aff09f5aa8467b8d
1 #include "cache.h"
2 #include "quote.h"
3 #include "argv-array.h"
5 int quote_path_fully = 1;
7 /* Help to copy the thing properly quoted for the shell safety.
8 * any single quote is replaced with '\'', any exclamation point
9 * is replaced with '\!', and the whole thing is enclosed in a
11 * E.g.
12 * original sq_quote result
13 * name ==> name ==> 'name'
14 * a b ==> a b ==> 'a b'
15 * a'b ==> a'\''b ==> 'a'\''b'
16 * a!b ==> a'\!'b ==> 'a'\!'b'
18 static inline int need_bs_quote(char c)
20 return (c == '\'' || c == '!');
23 void sq_quote_buf(struct strbuf *dst, const char *src)
25 char *to_free = NULL;
27 if (dst->buf == src)
28 to_free = strbuf_detach(dst, NULL);
30 strbuf_addch(dst, '\'');
31 while (*src) {
32 size_t len = strcspn(src, "'!");
33 strbuf_add(dst, src, len);
34 src += len;
35 while (need_bs_quote(*src)) {
36 strbuf_addstr(dst, "'\\");
37 strbuf_addch(dst, *src++);
38 strbuf_addch(dst, '\'');
41 strbuf_addch(dst, '\'');
42 free(to_free);
45 void sq_quote_argv(struct strbuf *dst, const char** argv, size_t maxlen)
47 int i;
49 /* Copy into destination buffer. */
50 strbuf_grow(dst, 255);
51 for (i = 0; argv[i]; ++i) {
52 strbuf_addch(dst, ' ');
53 sq_quote_buf(dst, argv[i]);
54 if (maxlen && dst->len > maxlen)
55 die("Too many or long arguments");
59 static char *sq_dequote_step(char *arg, char **next)
61 char *dst = arg;
62 char *src = arg;
63 char c;
65 if (*src != '\'')
66 return NULL;
67 for (;;) {
68 c = *++src;
69 if (!c)
70 return NULL;
71 if (c != '\'') {
72 *dst++ = c;
73 continue;
75 /* We stepped out of sq */
76 switch (*++src) {
77 case '\0':
78 *dst = 0;
79 if (next)
80 *next = NULL;
81 return arg;
82 case '\\':
83 c = *++src;
84 if (need_bs_quote(c) && *++src == '\'') {
85 *dst++ = c;
86 continue;
88 /* Fallthrough */
89 default:
90 if (!next || !isspace(*src))
91 return NULL;
92 do {
93 c = *++src;
94 } while (isspace(c));
95 *dst = 0;
96 *next = src;
97 return arg;
102 char *sq_dequote(char *arg)
104 return sq_dequote_step(arg, NULL);
107 static int sq_dequote_to_argv_internal(char *arg,
108 const char ***argv, int *nr, int *alloc,
109 struct argv_array *array)
111 char *next = arg;
113 if (!*arg)
114 return 0;
115 do {
116 char *dequoted = sq_dequote_step(next, &next);
117 if (!dequoted)
118 return -1;
119 if (argv) {
120 ALLOC_GROW(*argv, *nr + 1, *alloc);
121 (*argv)[(*nr)++] = dequoted;
123 if (array)
124 argv_array_push(array, dequoted);
125 } while (next);
127 return 0;
130 int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc)
132 return sq_dequote_to_argv_internal(arg, argv, nr, alloc, NULL);
135 int sq_dequote_to_argv_array(char *arg, struct argv_array *array)
137 return sq_dequote_to_argv_internal(arg, NULL, NULL, NULL, array);
140 /* 1 means: quote as octal
141 * 0 means: quote as octal if (quote_path_fully)
142 * -1 means: never quote
143 * c: quote as "\\c"
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,
151 /* 0x10 */ X16(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;
165 /* returns the longest prefix not needing a quote up to maxlen if positive.
166 This stops at the first \0 because it's marked as a character needing an
167 escape */
168 static size_t next_quote_pos(const char *s, ssize_t maxlen)
170 size_t len;
171 if (maxlen < 0) {
172 for (len = 0; !sq_must_quote(s[len]); len++);
173 } else {
174 for (len = 0; len < maxlen && !sq_must_quote(s[len]); len++);
176 return len;
180 * C-style name quoting.
182 * (1) if sb and fp are both NULL, inspect the input name and counts the
183 * number of bytes that are needed to hold c_style quoted version of name,
184 * counting the double quotes around it but not terminating NUL, and
185 * returns it.
186 * However, if name does not need c_style quoting, it returns 0.
188 * (2) if sb or fp are not NULL, it emits the c_style quoted version
189 * of name, enclosed with double quotes if asked and needed only.
190 * Return value is the same as in (1).
192 static size_t quote_c_style_counted(const char *name, ssize_t maxlen,
193 struct strbuf *sb, FILE *fp, int no_dq)
195 #undef EMIT
196 #define EMIT(c) \
197 do { \
198 if (sb) strbuf_addch(sb, (c)); \
199 if (fp) fputc((c), fp); \
200 count++; \
201 } while (0)
202 #define EMITBUF(s, l) \
203 do { \
204 if (sb) strbuf_add(sb, (s), (l)); \
205 if (fp) fwrite((s), (l), 1, fp); \
206 count += (l); \
207 } while (0)
209 size_t len, count = 0;
210 const char *p = name;
212 for (;;) {
213 int ch;
215 len = next_quote_pos(p, maxlen);
216 if (len == maxlen || (maxlen < 0 && !p[len]))
217 break;
219 if (!no_dq && p == name)
220 EMIT('"');
222 EMITBUF(p, len);
223 EMIT('\\');
224 p += len;
225 ch = (unsigned char)*p++;
226 if (maxlen >= 0)
227 maxlen -= len + 1;
228 if (sq_lookup[ch] >= ' ') {
229 EMIT(sq_lookup[ch]);
230 } else {
231 EMIT(((ch >> 6) & 03) + '0');
232 EMIT(((ch >> 3) & 07) + '0');
233 EMIT(((ch >> 0) & 07) + '0');
237 EMITBUF(p, len);
238 if (p == name) /* no ending quote needed */
239 return 0;
241 if (!no_dq)
242 EMIT('"');
243 return count;
246 size_t quote_c_style(const char *name, struct strbuf *sb, FILE *fp, int nodq)
248 return quote_c_style_counted(name, -1, sb, fp, nodq);
251 void quote_two_c_style(struct strbuf *sb, const char *prefix, const char *path, int nodq)
253 if (quote_c_style(prefix, NULL, NULL, 0) ||
254 quote_c_style(path, NULL, NULL, 0)) {
255 if (!nodq)
256 strbuf_addch(sb, '"');
257 quote_c_style(prefix, sb, NULL, 1);
258 quote_c_style(path, sb, NULL, 1);
259 if (!nodq)
260 strbuf_addch(sb, '"');
261 } else {
262 strbuf_addstr(sb, prefix);
263 strbuf_addstr(sb, path);
267 void write_name_quoted(const char *name, FILE *fp, int terminator)
269 if (terminator) {
270 quote_c_style(name, NULL, fp, 0);
271 } else {
272 fputs(name, fp);
274 fputc(terminator, fp);
277 void write_name_quotedpfx(const char *pfx, size_t pfxlen,
278 const char *name, FILE *fp, int terminator)
280 int needquote = 0;
282 if (terminator) {
283 needquote = next_quote_pos(pfx, pfxlen) < pfxlen
284 || name[next_quote_pos(name, -1)];
286 if (needquote) {
287 fputc('"', fp);
288 quote_c_style_counted(pfx, pfxlen, NULL, fp, 1);
289 quote_c_style(name, NULL, fp, 1);
290 fputc('"', fp);
291 } else {
292 fwrite(pfx, pfxlen, 1, fp);
293 fputs(name, fp);
295 fputc(terminator, fp);
298 void write_name_quoted_relative(const char *name, const char *prefix,
299 FILE *fp, int terminator)
301 struct strbuf sb = STRBUF_INIT;
303 name = relative_path(name, prefix, &sb);
304 write_name_quoted(name, fp, terminator);
306 strbuf_release(&sb);
309 /* quote path as relative to the given prefix */
310 char *quote_path_relative(const char *in, const char *prefix,
311 struct strbuf *out)
313 struct strbuf sb = STRBUF_INIT;
314 const char *rel = relative_path(in, prefix, &sb);
315 strbuf_reset(out);
316 quote_c_style_counted(rel, strlen(rel), out, NULL, 0);
317 strbuf_release(&sb);
319 return out->buf;
323 * C-style name unquoting.
325 * Quoted should point at the opening double quote.
326 * + Returns 0 if it was able to unquote the string properly, and appends the
327 * result in the strbuf `sb'.
328 * + Returns -1 in case of error, and doesn't touch the strbuf. Though note
329 * that this function will allocate memory in the strbuf, so calling
330 * strbuf_release is mandatory whichever result unquote_c_style returns.
332 * Updates endp pointer to point at one past the ending double quote if given.
334 int unquote_c_style(struct strbuf *sb, const char *quoted, const char **endp)
336 size_t oldlen = sb->len, len;
337 int ch, ac;
339 if (*quoted++ != '"')
340 return -1;
342 for (;;) {
343 len = strcspn(quoted, "\"\\");
344 strbuf_add(sb, quoted, len);
345 quoted += len;
347 switch (*quoted++) {
348 case '"':
349 if (endp)
350 *endp = quoted;
351 return 0;
352 case '\\':
353 break;
354 default:
355 goto error;
358 switch ((ch = *quoted++)) {
359 case 'a': ch = '\a'; break;
360 case 'b': ch = '\b'; break;
361 case 'f': ch = '\f'; break;
362 case 'n': ch = '\n'; break;
363 case 'r': ch = '\r'; break;
364 case 't': ch = '\t'; break;
365 case 'v': ch = '\v'; break;
367 case '\\': case '"':
368 break; /* verbatim */
370 /* octal values with first digit over 4 overflow */
371 case '0': case '1': case '2': case '3':
372 ac = ((ch - '0') << 6);
373 if ((ch = *quoted++) < '0' || '7' < ch)
374 goto error;
375 ac |= ((ch - '0') << 3);
376 if ((ch = *quoted++) < '0' || '7' < ch)
377 goto error;
378 ac |= (ch - '0');
379 ch = ac;
380 break;
381 default:
382 goto error;
384 strbuf_addch(sb, ch);
387 error:
388 strbuf_setlen(sb, oldlen);
389 return -1;
392 /* quoting as a string literal for other languages */
394 void perl_quote_buf(struct strbuf *sb, const char *src)
396 const char sq = '\'';
397 const char bq = '\\';
398 char c;
400 strbuf_addch(sb, sq);
401 while ((c = *src++)) {
402 if (c == sq || c == bq)
403 strbuf_addch(sb, bq);
404 strbuf_addch(sb, c);
406 strbuf_addch(sb, sq);
409 void python_quote_buf(struct strbuf *sb, const char *src)
411 const char sq = '\'';
412 const char bq = '\\';
413 const char nl = '\n';
414 char c;
416 strbuf_addch(sb, sq);
417 while ((c = *src++)) {
418 if (c == nl) {
419 strbuf_addch(sb, bq);
420 strbuf_addch(sb, 'n');
421 continue;
423 if (c == sq || c == bq)
424 strbuf_addch(sb, bq);
425 strbuf_addch(sb, c);
427 strbuf_addch(sb, sq);
430 void tcl_quote_buf(struct strbuf *sb, const char *src)
432 char c;
434 strbuf_addch(sb, '"');
435 while ((c = *src++)) {
436 switch (c) {
437 case '[': case ']':
438 case '{': case '}':
439 case '$': case '\\': case '"':
440 strbuf_addch(sb, '\\');
441 default:
442 strbuf_addch(sb, c);
443 break;
444 case '\f':
445 strbuf_addstr(sb, "\\f");
446 break;
447 case '\r':
448 strbuf_addstr(sb, "\\r");
449 break;
450 case '\n':
451 strbuf_addstr(sb, "\\n");
452 break;
453 case '\t':
454 strbuf_addstr(sb, "\\t");
455 break;
456 case '\v':
457 strbuf_addstr(sb, "\\v");
458 break;
461 strbuf_addch(sb, '"');