Revert part of d089eba (setup: sanitize absolute and funny paths in get_pathspec())
[git/git.git] / quote.h
CommitLineData
6fb737be
JH
1#ifndef QUOTE_H
2#define QUOTE_H
3
77d604c3 4#include <stddef.h>
4f6fbcdc 5#include <stdio.h>
6fb737be
JH
6
7/* Help to copy the thing properly quoted for the shell safety.
77d604c3
PA
8 * any single quote is replaced with '\'', any exclamation point
9 * is replaced with '\!', and the whole thing is enclosed in a
10 * single quote pair.
6fb737be
JH
11 *
12 * For example, if you are passing the result to system() as an
13 * argument:
14 *
15 * sprintf(cmd, "foobar %s %s", sq_quote(arg0), sq_quote(arg1))
16 *
17 * would be appropriate. If the system() is going to call ssh to
18 * run the command on the other side:
19 *
20 * sprintf(cmd, "git-diff-tree %s %s", sq_quote(arg0), sq_quote(arg1));
21 * sprintf(rcmd, "ssh %s %s", sq_quote(host), sq_quote(cmd));
22 *
23 * Note that the above examples leak memory! Remember to free result from
24 * sq_quote() in a real application.
77d604c3
PA
25 *
26 * sq_quote_buf() writes to an existing buffer of specified size; it
27 * will return the number of characters that would have been written
28 * excluding the final null regardless of the buffer size.
6fb737be
JH
29 */
30
575ba9d6 31extern void sq_quote_print(FILE *stream, const char *src);
4f6fbcdc 32
7a33bcbe 33extern void sq_quote_buf(struct strbuf *, const char *src);
b319ce4c 34extern void sq_quote_argv(struct strbuf *, const char **argv, size_t maxlen);
86257aa3 35
35eb2d36
LT
36/* This unwraps what sq_quote() produces in place, but returns
37 * NULL if the input does not look like what sq_quote would have
38 * produced.
39 */
40extern char *sq_dequote(char *);
41
7fb1011e 42extern int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
663af342 43extern size_t quote_c_style(const char *name, struct strbuf *, FILE *, int no_dq);
d5625091 44extern void quote_two_c_style(struct strbuf *, const char *, const char *, int);
4f6fbcdc 45
663af342
PH
46extern void write_name_quoted(const char *name, FILE *, int terminator);
47extern void write_name_quotedpfx(const char *pfx, size_t pfxlen,
48 const char *name, FILE *, int terminator);
6fb737be 49
9f613ddd
JH
50/* quoting as a string literal for other languages */
51extern void perl_quote_print(FILE *stream, const char *src);
52extern void python_quote_print(FILE *stream, const char *src);
5558e55c 53extern void tcl_quote_print(FILE *stream, const char *src);
9f613ddd 54
6fb737be 55#endif