4 /* Help to copy the thing properly quoted for the shell safety.
5 * any single quote is replaced with '\'', any exclamation point
6 * is replaced with '\!', and the whole thing is enclosed in a
9 * original sq_quote result
10 * name ==> name ==> 'name'
11 * a b ==> a b ==> 'a b'
12 * a'b ==> a'\''b ==> 'a'\''b'
13 * a!b ==> a'\!'b ==> 'a'\!'b'
16 #define EMIT(x) do { if (++len < n) *bp++ = (x); } while(0)
18 static inline int need_bs_quote(char c
)
20 return (c
== '\'' || c
== '!');
23 static size_t sq_quote_buf(char *dst
, size_t n
, const char *src
)
30 while ((c
= *src
++)) {
31 if (need_bs_quote(c
)) {
48 void sq_quote_print(FILE *stream
, const char *src
)
53 while ((c
= *src
++)) {
54 if (need_bs_quote(c
)) {
65 char *sq_quote_argv(const char** argv
, int count
)
71 /* Count argv if needed. */
73 for (count
= 0; argv
[count
]; count
++)
77 /* Special case: no argv. */
81 /* Get destination buffer length. */
82 for (i
= 0; i
< count
; i
++)
83 len
+= sq_quote_buf(NULL
, 0, argv
[i
]) + 1;
85 /* Alloc destination buffer. */
86 to
= buf
= xmalloc(len
+ 1);
88 /* Copy into destination buffer. */
89 for (i
= 0; i
< count
; ++i
) {
91 to
+= sq_quote_buf(to
, len
, argv
[i
]);
98 * Append a string to a string buffer, with or without shell quoting.
99 * Return true if the buffer overflowed.
101 int add_to_string(char **ptrp
, int *sizep
, const char *str
, int quote
)
109 oc
= sq_quote_buf(p
, size
, str
);
112 memcpy(p
, str
, (size
<= oc
) ? size
- 1 : oc
);
126 char *sq_dequote(char *arg
)
142 /* We stepped out of sq */
149 if (need_bs_quote(c
) && *++src
== '\'') {
161 * C-style name quoting.
163 * Does one of three things:
165 * (1) if outbuf and outfp are both NULL, inspect the input name and
166 * counts the number of bytes that are needed to hold c_style
167 * quoted version of name, counting the double quotes around
168 * it but not terminating NUL, and returns it. However, if name
169 * does not need c_style quoting, it returns 0.
171 * (2) if outbuf is not NULL, it must point at a buffer large enough
172 * to hold the c_style quoted version of name, enclosing double
173 * quotes, and terminating NUL. Fills outbuf with c_style quoted
174 * version of name enclosed in double-quote pair. Return value
177 * (3) if outfp is not NULL, outputs c_style quoted version of name,
178 * but not enclosed in double-quote pair. Return value is undefined.
181 static int quote_c_style_counted(const char *name
, int namelen
,
182 char *outbuf
, FILE *outfp
, int no_dq
)
186 (outbuf ? (*outbuf++ = (c)) : outfp ? fputc(c, outfp) : (count++))
188 #define EMITQ() EMIT('\\')
192 int count
= 0, needquote
= 0;
196 for (sp
= name
; sp
< name
+ namelen
; sp
++) {
200 if ((ch
< ' ') || (ch
== '"') || (ch
== '\\') ||
201 (quote_path_fully
&& (ch
>= 0177))) {
204 case '\a': EMITQ(); ch
= 'a'; break;
205 case '\b': EMITQ(); ch
= 'b'; break;
206 case '\f': EMITQ(); ch
= 'f'; break;
207 case '\n': EMITQ(); ch
= 'n'; break;
208 case '\r': EMITQ(); ch
= 'r'; break;
209 case '\t': EMITQ(); ch
= 't'; break;
210 case '\v': EMITQ(); ch
= 'v'; break;
212 case '\\': /* fallthru */
213 case '"': EMITQ(); break;
217 EMIT(((ch
>> 6) & 03) + '0');
218 EMIT(((ch
>> 3) & 07) + '0');
219 ch
= (ch
& 07) + '0';
230 return needquote
? count
: 0;
233 int quote_c_style(const char *name
, char *outbuf
, FILE *outfp
, int no_dq
)
235 int cnt
= strlen(name
);
236 return quote_c_style_counted(name
, cnt
, outbuf
, outfp
, no_dq
);
240 * C-style name unquoting.
242 * Quoted should point at the opening double quote.
243 * + Returns 0 if it was able to unquote the string properly, and appends the
244 * result in the strbuf `sb'.
245 * + Returns -1 in case of error, and doesn't touch the strbuf. Though note
246 * that this function will allocate memory in the strbuf, so calling
247 * strbuf_release is mandatory whichever result unquote_c_style returns.
249 * Updates endp pointer to point at one past the ending double quote if given.
251 int unquote_c_style(struct strbuf
*sb
, const char *quoted
, const char **endp
)
253 size_t oldlen
= sb
->len
, len
;
256 if (*quoted
++ != '"')
260 len
= strcspn(quoted
, "\"\\");
261 strbuf_add(sb
, quoted
, len
);
275 switch ((ch
= *quoted
++)) {
276 case 'a': ch
= '\a'; break;
277 case 'b': ch
= '\b'; break;
278 case 'f': ch
= '\f'; break;
279 case 'n': ch
= '\n'; break;
280 case 'r': ch
= '\r'; break;
281 case 't': ch
= '\t'; break;
282 case 'v': ch
= '\v'; break;
285 break; /* verbatim */
287 /* octal values with first digit over 4 overflow */
288 case '0': case '1': case '2': case '3':
289 ac
= ((ch
- '0') << 6);
290 if ((ch
= *quoted
++) < '0' || '7' < ch
)
292 ac
|= ((ch
- '0') << 3);
293 if ((ch
= *quoted
++) < '0' || '7' < ch
)
301 strbuf_addch(sb
, ch
);
305 strbuf_setlen(sb
, oldlen
);
309 void write_name_quoted(const char *prefix
, int prefix_len
,
310 const char *name
, int quote
, FILE *out
)
317 fprintf(out
, "%.*s", prefix_len
, prefix
);
324 needquote
= quote_c_style_counted(prefix
, prefix_len
,
327 needquote
= quote_c_style(name
, NULL
, NULL
, 0);
331 quote_c_style_counted(prefix
, prefix_len
,
333 quote_c_style(name
, NULL
, out
, 1);
340 /* quoting as a string literal for other languages */
342 void perl_quote_print(FILE *stream
, const char *src
)
344 const char sq
= '\'';
345 const char bq
= '\\';
349 while ((c
= *src
++)) {
350 if (c
== sq
|| c
== bq
)
357 void python_quote_print(FILE *stream
, const char *src
)
359 const char sq
= '\'';
360 const char bq
= '\\';
361 const char nl
= '\n';
365 while ((c
= *src
++)) {
371 if (c
== sq
|| c
== bq
)
378 void tcl_quote_print(FILE *stream
, const char *src
)
383 while ((c
= *src
++)) {
387 case '$': case '\\': case '"':
393 fputs("\\f", stream
);
396 fputs("\\r", stream
);
399 fputs("\\n", stream
);
402 fputs("\\t", stream
);
405 fputs("\\v", stream
);